BucketArgs

data class BucketArgs(val acl: Output<List<BucketAccessControlArgs>>? = null, val autoclass: Output<BucketAutoclassArgs>? = null, val billing: Output<BucketBillingArgs>? = null, val cors: Output<List<BucketCorsItemArgs>>? = null, val customPlacementConfig: Output<BucketCustomPlacementConfigArgs>? = null, val defaultEventBasedHold: Output<Boolean>? = null, val defaultObjectAcl: Output<List<ObjectAccessControlArgs>>? = null, val encryption: Output<BucketEncryptionArgs>? = null, val etag: Output<String>? = null, val iamConfiguration: Output<BucketIamConfigurationArgs>? = null, val id: Output<String>? = null, val kind: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val lifecycle: Output<BucketLifecycleArgs>? = null, val location: Output<String>? = null, val locationType: Output<String>? = null, val logging: Output<BucketLoggingArgs>? = null, val metageneration: Output<String>? = null, val name: Output<String>? = null, val owner: Output<BucketOwnerArgs>? = null, val predefinedAcl: Output<String>? = null, val predefinedDefaultObjectAcl: Output<String>? = null, val project: Output<String>? = null, val projectNumber: Output<String>? = null, val projection: Output<String>? = null, val retentionPolicy: Output<BucketRetentionPolicyArgs>? = null, val rpo: Output<String>? = null, val satisfiesPZS: Output<Boolean>? = null, val selfLink: Output<String>? = null, val storageClass: Output<String>? = null, val timeCreated: Output<String>? = null, val updated: Output<String>? = null, val userProject: Output<String>? = null, val versioning: Output<BucketVersioningArgs>? = null, val website: Output<BucketWebsiteArgs>? = null) : ConvertibleToJava<BucketArgs>

Creates a new bucket.

Constructors

Link copied to clipboard
fun BucketArgs(acl: Output<List<BucketAccessControlArgs>>? = null, autoclass: Output<BucketAutoclassArgs>? = null, billing: Output<BucketBillingArgs>? = null, cors: Output<List<BucketCorsItemArgs>>? = null, customPlacementConfig: Output<BucketCustomPlacementConfigArgs>? = null, defaultEventBasedHold: Output<Boolean>? = null, defaultObjectAcl: Output<List<ObjectAccessControlArgs>>? = null, encryption: Output<BucketEncryptionArgs>? = null, etag: Output<String>? = null, iamConfiguration: Output<BucketIamConfigurationArgs>? = null, id: Output<String>? = null, kind: Output<String>? = null, labels: Output<Map<String, String>>? = null, lifecycle: Output<BucketLifecycleArgs>? = null, location: Output<String>? = null, locationType: Output<String>? = null, logging: Output<BucketLoggingArgs>? = null, metageneration: Output<String>? = null, name: Output<String>? = null, owner: Output<BucketOwnerArgs>? = null, predefinedAcl: Output<String>? = null, predefinedDefaultObjectAcl: Output<String>? = null, project: Output<String>? = null, projectNumber: Output<String>? = null, projection: Output<String>? = null, retentionPolicy: Output<BucketRetentionPolicyArgs>? = null, rpo: Output<String>? = null, satisfiesPZS: Output<Boolean>? = null, selfLink: Output<String>? = null, storageClass: Output<String>? = null, timeCreated: Output<String>? = null, updated: Output<String>? = null, userProject: Output<String>? = null, versioning: Output<BucketVersioningArgs>? = null, website: Output<BucketWebsiteArgs>? = null)

Functions

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

Properties

Link copied to clipboard
val acl: Output<List<BucketAccessControlArgs>>? = null

Access controls on the bucket.

Link copied to clipboard
val autoclass: Output<BucketAutoclassArgs>? = null

The bucket's Autoclass configuration.

Link copied to clipboard
val billing: Output<BucketBillingArgs>? = null

The bucket's billing configuration.

Link copied to clipboard
val cors: Output<List<BucketCorsItemArgs>>? = null

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

Link copied to clipboard

The bucket's custom placement configuration for Custom Dual Regions.

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

The 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.

Link copied to clipboard

Default access controls to apply to new objects when no ACL is provided.

Link copied to clipboard
val encryption: Output<BucketEncryptionArgs>? = null

Encryption configuration for a bucket.

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

HTTP 1.1 Entity tag for the bucket.

Link copied to clipboard

The bucket's IAM configuration.

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

The ID of the bucket. For buckets, the id and name properties are the same.

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

The kind of item this is. For buckets, this is always storage#bucket.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

User-provided labels, in key/value pairs.

Link copied to clipboard
val lifecycle: Output<BucketLifecycleArgs>? = null

The bucket's lifecycle configuration. See lifecycle management for more information.

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

The 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 for the authoritative list.

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

The type of the bucket location.

Link copied to clipboard
val logging: Output<BucketLoggingArgs>? = null

The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.

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

The metadata generation of this bucket.

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

The name of the bucket.

Link copied to clipboard
val owner: Output<BucketOwnerArgs>? = null

The owner of the bucket. This is always the project team's owner group.

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

Apply a predefined set of access controls to this bucket.

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

Apply a predefined set of default object access controls to this bucket.

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

A valid API project identifier.

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

Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.

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

The project number of the project the bucket belongs to.

Link copied to clipboard

The 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.

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

The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.

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

Reserved for future use.

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

The URI of this bucket.

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

The 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.

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

The creation time of the bucket in RFC 3339 format.

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

The modification time of the bucket in RFC 3339 format.

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

The project to be billed for this request.

Link copied to clipboard
val versioning: Output<BucketVersioningArgs>? = null

The bucket's versioning configuration.

Link copied to clipboard
val website: Output<BucketWebsiteArgs>? = null

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.