Cloud Storage Bucket

A Cloud Storage Bucket in GCP is a scalable container for storing objects such as files, images, and backups. It provides durable, highly available storage with options for different storage classes to balance cost and performance. Buckets support fine-grained access control, lifecycle management, and integration with other Google Cloud services, making them suitable for both active data and long-term archival.

gcp.storage_bucket

Fields

TitleIDTypeData TypeDescription
_keycorestring
aclcorejsonAccess controls on the bucket.
ancestorscorearray<string>
autoclasscorejsonThe bucket's Autoclass configuration.
billingcorejsonThe bucket's billing configuration.
corscorejsonThe bucket's Cross-Origin Resource Sharing (CORS) configuration.
custom_placement_configcorejsonThe bucket's custom placement configuration for Custom Dual Regions.
datadog_display_namecorestring
default_event_based_holdcoreboolThe default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
default_object_aclcorejsonDefault access controls to apply to new objects when no ACL is provided.
encryptioncorejsonEncryption configuration for a bucket.
etagcorestringHTTP 1.1 Entity tag for the bucket.
iam_configurationcorejsonThe bucket's IAM configuration.
idcorestringThe ID of the bucket. For buckets, the id and name properties are the same.
kindcorestringThe kind of item this is. For buckets, this is always storage#bucket.
labelscorearray<string>User-provided labels, in key/value pairs.
lifecyclecorejsonThe bucket's lifecycle configuration. See [Lifecycle Management](https://cloud.google.com/storage/docs/lifecycle) for more information.
locationcorestringThe location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the [Developer's Guide](https://cloud.google.com/storage/docs/locations) for the authoritative list.
location_typecorestringThe type of the bucket location.
loggingcorejsonThe bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
metagenerationcoreint64The metadata generation of this bucket.
namecorestringThe name of the bucket.
organization_idcorestring
ownercorejsonThe owner of the bucket. This is always the project team's owner group.
parentcorestring
project_idcorestring
project_numbercorestringThe project number of the project the bucket belongs to.
resource_namecorestring
retention_policycorejsonThe bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
rpocorestringThe Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfies_pzscoreboolReserved for future use.
self_linkcorestringThe URI of this bucket.
storage_classcorestringThe bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes).
tagscorehstore
time_createdcoretimestampThe creation time of the bucket in RFC 3339 format.
updatedcoretimestampThe modification time of the bucket in RFC 3339 format.
versioningcorejsonThe bucket's versioning configuration.
websitecorejsonThe bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the [Static Website Examples](https://cloud.google.com/storage/docs/static-website) for more information.