OrganizationBucketArgs class

The set of arguments for OrganizationBucket. The set of arguments for OrganizationBucket.

Constructors

OrganizationBucketArgs({Input<bool>? analyticsEnabled, required Input<String> bucketId, Input<CmekSettings>? cmekSettings, Input<String>? description, Input<List<IndexConfig>>? indexConfigs, Input<String>? location, Input<bool>? locked, required Input<String> organizationId, Input<List<String>>? restrictedFields, Input<int>? retentionDays})
Creates a new OrganizationBucketArgs. analyticsEnabled Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. bucketId 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. 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 Describes this bucket. indexConfigs A list of indexed fields and related configuration data. location Optional. locked 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. organizationId Required. restrictedFields 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 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.
const
OrganizationBucketArgs.fromMap(Map<String, dynamic> map)
factory

Properties

analyticsEnabled → Input<bool>?
Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
final
bucketId → Input<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.
final
cmekSettings → Input<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.
final
description → Input<String>?
Describes this bucket.
final
hashCode → int
The hash code for this object.
no setterinherited
indexConfigs → Input<List<IndexConfig>>?
A list of indexed fields and related configuration data.
final
location → Input<String>?
final
locked → Input<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.
final
organizationId → Input<String>
final
restrictedFields → Input<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)
final
retentionDays → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited