Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. logging
  5. logging/v2
  6. BillingAccountBucket

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.logging/v2.BillingAccountBucket

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket’s location cannot be changed. Auto-naming is currently not supported for this resource.

Create BillingAccountBucket Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BillingAccountBucket(name: string, args: BillingAccountBucketArgs, opts?: CustomResourceOptions);
@overload
def BillingAccountBucket(resource_name: str,
                         args: BillingAccountBucketArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def BillingAccountBucket(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         billing_account_id: Optional[str] = None,
                         bucket_id: Optional[str] = None,
                         analytics_enabled: Optional[bool] = None,
                         cmek_settings: Optional[CmekSettingsArgs] = None,
                         description: Optional[str] = None,
                         index_configs: Optional[Sequence[IndexConfigArgs]] = None,
                         location: Optional[str] = None,
                         locked: Optional[bool] = None,
                         restricted_fields: Optional[Sequence[str]] = None,
                         retention_days: Optional[int] = None)
func NewBillingAccountBucket(ctx *Context, name string, args BillingAccountBucketArgs, opts ...ResourceOption) (*BillingAccountBucket, error)
public BillingAccountBucket(string name, BillingAccountBucketArgs args, CustomResourceOptions? opts = null)
public BillingAccountBucket(String name, BillingAccountBucketArgs args)
public BillingAccountBucket(String name, BillingAccountBucketArgs args, CustomResourceOptions options)

type: google-native:logging/v2:BillingAccountBucket
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BillingAccountBucketArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BillingAccountBucketArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BillingAccountBucketArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BillingAccountBucketArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BillingAccountBucketArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var billingAccountBucketResource = new GoogleNative.Logging.V2.BillingAccountBucket("billingAccountBucketResource", new()
{
    BillingAccountId = "string",
    BucketId = "string",
    AnalyticsEnabled = false,
    CmekSettings = new GoogleNative.Logging.V2.Inputs.CmekSettingsArgs
    {
        KmsKeyName = "string",
        KmsKeyVersionName = "string",
    },
    Description = "string",
    IndexConfigs = new[]
    {
        new GoogleNative.Logging.V2.Inputs.IndexConfigArgs
        {
            FieldPath = "string",
            Type = GoogleNative.Logging.V2.IndexConfigType.IndexTypeUnspecified,
        },
    },
    Location = "string",
    Locked = false,
    RestrictedFields = new[]
    {
        "string",
    },
    RetentionDays = 0,
});
Copy
example, err := logging.NewBillingAccountBucket(ctx, "billingAccountBucketResource", &logging.BillingAccountBucketArgs{
	BillingAccountId: pulumi.String("string"),
	BucketId:         pulumi.String("string"),
	AnalyticsEnabled: pulumi.Bool(false),
	CmekSettings: &logging.CmekSettingsArgs{
		KmsKeyName:        pulumi.String("string"),
		KmsKeyVersionName: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	IndexConfigs: logging.IndexConfigArray{
		&logging.IndexConfigArgs{
			FieldPath: pulumi.String("string"),
			Type:      logging.IndexConfigTypeIndexTypeUnspecified,
		},
	},
	Location: pulumi.String("string"),
	Locked:   pulumi.Bool(false),
	RestrictedFields: pulumi.StringArray{
		pulumi.String("string"),
	},
	RetentionDays: pulumi.Int(0),
})
Copy
var billingAccountBucketResource = new BillingAccountBucket("billingAccountBucketResource", BillingAccountBucketArgs.builder()
    .billingAccountId("string")
    .bucketId("string")
    .analyticsEnabled(false)
    .cmekSettings(CmekSettingsArgs.builder()
        .kmsKeyName("string")
        .kmsKeyVersionName("string")
        .build())
    .description("string")
    .indexConfigs(IndexConfigArgs.builder()
        .fieldPath("string")
        .type("INDEX_TYPE_UNSPECIFIED")
        .build())
    .location("string")
    .locked(false)
    .restrictedFields("string")
    .retentionDays(0)
    .build());
Copy
billing_account_bucket_resource = google_native.logging.v2.BillingAccountBucket("billingAccountBucketResource",
    billing_account_id="string",
    bucket_id="string",
    analytics_enabled=False,
    cmek_settings={
        "kms_key_name": "string",
        "kms_key_version_name": "string",
    },
    description="string",
    index_configs=[{
        "field_path": "string",
        "type": google_native.logging.v2.IndexConfigType.INDEX_TYPE_UNSPECIFIED,
    }],
    location="string",
    locked=False,
    restricted_fields=["string"],
    retention_days=0)
Copy
const billingAccountBucketResource = new google_native.logging.v2.BillingAccountBucket("billingAccountBucketResource", {
    billingAccountId: "string",
    bucketId: "string",
    analyticsEnabled: false,
    cmekSettings: {
        kmsKeyName: "string",
        kmsKeyVersionName: "string",
    },
    description: "string",
    indexConfigs: [{
        fieldPath: "string",
        type: google_native.logging.v2.IndexConfigType.IndexTypeUnspecified,
    }],
    location: "string",
    locked: false,
    restrictedFields: ["string"],
    retentionDays: 0,
});
Copy
type: google-native:logging/v2:BillingAccountBucket
properties:
    analyticsEnabled: false
    billingAccountId: string
    bucketId: string
    cmekSettings:
        kmsKeyName: string
        kmsKeyVersionName: string
    description: string
    indexConfigs:
        - fieldPath: string
          type: INDEX_TYPE_UNSPECIFIED
    location: string
    locked: false
    restrictedFields:
        - string
    retentionDays: 0
Copy

BillingAccountBucket Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BillingAccountBucket resource accepts the following input properties:

BillingAccountId
This property is required.
Changes to this property will trigger replacement.
string
BucketId
This property is required.
Changes to this property will trigger replacement.
string
Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
AnalyticsEnabled bool
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
CmekSettings Pulumi.GoogleNative.Logging.V2.Inputs.CmekSettings
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
Description string
Describes this bucket.
IndexConfigs List<Pulumi.GoogleNative.Logging.V2.Inputs.IndexConfig>
A list of indexed fields and related configuration data.
Location Changes to this property will trigger replacement. string
Locked bool
Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
RestrictedFields List<string>
Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)
RetentionDays int
Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
BillingAccountId
This property is required.
Changes to this property will trigger replacement.
string
BucketId
This property is required.
Changes to this property will trigger replacement.
string
Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
AnalyticsEnabled bool
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
CmekSettings CmekSettingsArgs
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
Description string
Describes this bucket.
IndexConfigs []IndexConfigArgs
A list of indexed fields and related configuration data.
Location Changes to this property will trigger replacement. string
Locked bool
Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
RestrictedFields []string
Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)
RetentionDays int
Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
billingAccountId
This property is required.
Changes to this property will trigger replacement.
String
bucketId
This property is required.
Changes to this property will trigger replacement.
String
Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
analyticsEnabled Boolean
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
cmekSettings CmekSettings
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
description String
Describes this bucket.
indexConfigs List<IndexConfig>
A list of indexed fields and related configuration data.
location Changes to this property will trigger replacement. String
locked Boolean
Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
restrictedFields List<String>
Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)
retentionDays Integer
Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
billingAccountId
This property is required.
Changes to this property will trigger replacement.
string
bucketId
This property is required.
Changes to this property will trigger replacement.
string
Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
analyticsEnabled boolean
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
cmekSettings CmekSettings
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
description string
Describes this bucket.
indexConfigs IndexConfig[]
A list of indexed fields and related configuration data.
location Changes to this property will trigger replacement. string
locked boolean
Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
restrictedFields string[]
Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)
retentionDays number
Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
billing_account_id
This property is required.
Changes to this property will trigger replacement.
str
bucket_id
This property is required.
Changes to this property will trigger replacement.
str
Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
analytics_enabled bool
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
cmek_settings CmekSettingsArgs
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
description str
Describes this bucket.
index_configs Sequence[IndexConfigArgs]
A list of indexed fields and related configuration data.
location Changes to this property will trigger replacement. str
locked bool
Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
restricted_fields Sequence[str]
Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)
retention_days int
Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
billingAccountId
This property is required.
Changes to this property will trigger replacement.
String
bucketId
This property is required.
Changes to this property will trigger replacement.
String
Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.
analyticsEnabled Boolean
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
cmekSettings Property Map
The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
description String
Describes this bucket.
indexConfigs List<Property Map>
A list of indexed fields and related configuration data.
location Changes to this property will trigger replacement. String
locked Boolean
Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
restrictedFields List<String>
Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)
retentionDays Number
Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

Outputs

All input properties are implicitly available as output properties. Additionally, the BillingAccountBucket resource produces the following output properties:

CreateTime string
The creation timestamp of the bucket. This is not set for any of the default buckets.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleState string
The bucket lifecycle state.
Name string
The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
UpdateTime string
The last update timestamp of the bucket.
CreateTime string
The creation timestamp of the bucket. This is not set for any of the default buckets.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleState string
The bucket lifecycle state.
Name string
The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
UpdateTime string
The last update timestamp of the bucket.
createTime String
The creation timestamp of the bucket. This is not set for any of the default buckets.
id String
The provider-assigned unique ID for this managed resource.
lifecycleState String
The bucket lifecycle state.
name String
The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
updateTime String
The last update timestamp of the bucket.
createTime string
The creation timestamp of the bucket. This is not set for any of the default buckets.
id string
The provider-assigned unique ID for this managed resource.
lifecycleState string
The bucket lifecycle state.
name string
The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
updateTime string
The last update timestamp of the bucket.
create_time str
The creation timestamp of the bucket. This is not set for any of the default buckets.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_state str
The bucket lifecycle state.
name str
The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
update_time str
The last update timestamp of the bucket.
createTime String
The creation timestamp of the bucket. This is not set for any of the default buckets.
id String
The provider-assigned unique ID for this managed resource.
lifecycleState String
The bucket lifecycle state.
name String
The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
updateTime String
The last update timestamp of the bucket.

Supporting Types

CmekSettings
, CmekSettingsArgs

KmsKeyName string
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
KmsKeyVersionName string
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
KmsKeyName string
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
KmsKeyVersionName string
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
kmsKeyName String
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyVersionName String
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
kmsKeyName string
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyVersionName string
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
kms_key_name str
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kms_key_version_name str
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
kmsKeyName String
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyVersionName String
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.

CmekSettingsResponse
, CmekSettingsResponseArgs

KmsKeyName This property is required. string
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
KmsKeyVersionName This property is required. string
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
Name This property is required. string
The resource name of the CMEK settings.
ServiceAccountId This property is required. string
The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
KmsKeyName This property is required. string
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
KmsKeyVersionName This property is required. string
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
Name This property is required. string
The resource name of the CMEK settings.
ServiceAccountId This property is required. string
The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyName This property is required. String
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyVersionName This property is required. String
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
name This property is required. String
The resource name of the CMEK settings.
serviceAccountId This property is required. String
The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyName This property is required. string
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyVersionName This property is required. string
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
name This property is required. string
The resource name of the CMEK settings.
serviceAccountId This property is required. string
The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kms_key_name This property is required. str
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kms_key_version_name This property is required. str
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
name This property is required. str
The resource name of the CMEK settings.
service_account_id This property is required. str
The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyName This property is required. String
The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
kmsKeyVersionName This property is required. String
The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
name This property is required. String
The resource name of the CMEK settings.
serviceAccountId This property is required. String
The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

IndexConfig
, IndexConfigArgs

FieldPath This property is required. string
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
Type This property is required. Pulumi.GoogleNative.Logging.V2.IndexConfigType
The type of data in this index.
FieldPath This property is required. string
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
Type This property is required. IndexConfigType
The type of data in this index.
fieldPath This property is required. String
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. IndexConfigType
The type of data in this index.
fieldPath This property is required. string
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. IndexConfigType
The type of data in this index.
field_path This property is required. str
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. IndexConfigType
The type of data in this index.
fieldPath This property is required. String
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. "INDEX_TYPE_UNSPECIFIED" | "INDEX_TYPE_STRING" | "INDEX_TYPE_INTEGER"
The type of data in this index.

IndexConfigResponse
, IndexConfigResponseArgs

CreateTime This property is required. string
The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.
FieldPath This property is required. string
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
Type This property is required. string
The type of data in this index.
CreateTime This property is required. string
The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.
FieldPath This property is required. string
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
Type This property is required. string
The type of data in this index.
createTime This property is required. String
The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.
fieldPath This property is required. String
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. String
The type of data in this index.
createTime This property is required. string
The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.
fieldPath This property is required. string
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. string
The type of data in this index.
create_time This property is required. str
The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.
field_path This property is required. str
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. str
The type of data in this index.
createTime This property is required. String
The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.
fieldPath This property is required. String
The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status
type This property is required. String
The type of data in this index.

IndexConfigType
, IndexConfigTypeArgs

IndexTypeUnspecified
INDEX_TYPE_UNSPECIFIEDThe index's type is unspecified.
IndexTypeString
INDEX_TYPE_STRINGThe index is a string-type index.
IndexTypeInteger
INDEX_TYPE_INTEGERThe index is a integer-type index.
IndexConfigTypeIndexTypeUnspecified
INDEX_TYPE_UNSPECIFIEDThe index's type is unspecified.
IndexConfigTypeIndexTypeString
INDEX_TYPE_STRINGThe index is a string-type index.
IndexConfigTypeIndexTypeInteger
INDEX_TYPE_INTEGERThe index is a integer-type index.
IndexTypeUnspecified
INDEX_TYPE_UNSPECIFIEDThe index's type is unspecified.
IndexTypeString
INDEX_TYPE_STRINGThe index is a string-type index.
IndexTypeInteger
INDEX_TYPE_INTEGERThe index is a integer-type index.
IndexTypeUnspecified
INDEX_TYPE_UNSPECIFIEDThe index's type is unspecified.
IndexTypeString
INDEX_TYPE_STRINGThe index is a string-type index.
IndexTypeInteger
INDEX_TYPE_INTEGERThe index is a integer-type index.
INDEX_TYPE_UNSPECIFIED
INDEX_TYPE_UNSPECIFIEDThe index's type is unspecified.
INDEX_TYPE_STRING
INDEX_TYPE_STRINGThe index is a string-type index.
INDEX_TYPE_INTEGER
INDEX_TYPE_INTEGERThe index is a integer-type index.
"INDEX_TYPE_UNSPECIFIED"
INDEX_TYPE_UNSPECIFIEDThe index's type is unspecified.
"INDEX_TYPE_STRING"
INDEX_TYPE_STRINGThe index is a string-type index.
"INDEX_TYPE_INTEGER"
INDEX_TYPE_INTEGERThe index is a integer-type index.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native