A Log Bucket in Google Cloud is a specialized storage container within Cloud Logging that holds log entries. It allows you to centralize, organize, and retain logs for analysis, compliance, or troubleshooting. You can configure retention policies, set access controls, and route logs from multiple projects or services into a single bucket for easier management.

gcp.logging_log_bucket

Fields

TitleIDTypeData TypeDescription
_keycorestring
analytics_enabledcoreboolOptional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
ancestorscorearray<string>
cmek_settingscorejsonOptional. 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.
create_timecoretimestampOutput only. The creation timestamp of the bucket. This is not set for any of the default buckets.
datadog_display_namecorestring
descriptioncorestringOptional. Describes this bucket.
index_configscorejsonOptional. A list of indexed fields and related configuration data.
labelscorearray<string>
lifecycle_statecorestringOutput only. The bucket lifecycle state.
lockedcoreboolOptional. 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.
namecorestringOutput only. 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.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
resource_namecorestring
restricted_fieldscorearray<string>Optional. 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_dayscoreint64Optional. 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.
tagscorehstore
update_timecoretimestampOutput only. The last update timestamp of the bucket.