BucketArgs

data class BucketArgs(val analyticsEnabled: Output<Boolean>? = null, val bucketId: Output<String>? = null, val cmekSettings: Output<CmekSettingsArgs>? = null, val description: Output<String>? = null, val indexConfigs: Output<List<IndexConfigArgs>>? = null, val location: Output<String>? = null, val locked: Output<Boolean>? = null, val project: Output<String>? = null, val restrictedFields: Output<List<String>>? = null, val retentionDays: Output<Int>? = null) : ConvertibleToJava<BucketArgs>

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.

Constructors

Link copied to clipboard
fun BucketArgs(analyticsEnabled: Output<Boolean>? = null, bucketId: Output<String>? = null, cmekSettings: Output<CmekSettingsArgs>? = null, description: Output<String>? = null, indexConfigs: Output<List<IndexConfigArgs>>? = null, location: Output<String>? = null, locked: Output<Boolean>? = null, project: Output<String>? = null, restrictedFields: Output<List<String>>? = null, retentionDays: Output<Int>? = null)

Functions

Link copied to clipboard
open override fun toJava(): BucketArgs

Properties

Link copied to clipboard
val analyticsEnabled: Output<Boolean>? = null

Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.

Link copied to clipboard
val bucketId: Output<String>? = null

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.

Link copied to clipboard
val cmekSettings: Output<CmekSettingsArgs>? = null

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.

Link copied to clipboard
val description: Output<String>? = null

Describes this bucket.

Link copied to clipboard
val indexConfigs: Output<List<IndexConfigArgs>>? = null

A list of indexed fields and related configuration data.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val locked: Output<Boolean>? = null

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.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val restrictedFields: Output<List<String>>? = null

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)

Link copied to clipboard
val retentionDays: Output<Int>? = null

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.