Struct BucketArgs

pub struct BucketArgs {

    pub autoclass: Output<Option<BucketAutoclass>>,
    pub cors: Output<Option<Vec<BucketCor>>>,
    pub custom_placement_config: Output<Option<BucketCustomPlacementConfig>>,
    pub default_event_based_hold: Output<Option<bool>>,
    pub enable_object_retention: Output<Option<bool>>,
    pub encryption: Output<Option<BucketEncryption>>,
    pub force_destroy: Output<Option<bool>>,
    pub hierarchical_namespace: Output<Option<BucketHierarchicalNamespace>>,
    pub labels: Output<Option<HashMap<String, String>>>,
    pub lifecycle_rules: Output<Option<Vec<BucketLifecycleRule>>>,
    pub location: Output<String>,
    pub logging: Output<Option<BucketLogging>>,
    pub name: Output<Option<String>>,
    pub project: Output<Option<String>>,
    pub public_access_prevention: Output<Option<String>>,
    pub requester_pays: Output<Option<bool>>,
    pub retention_policy: Output<Option<BucketRetentionPolicy>>,
    pub rpo: Output<Option<String>>,
    pub soft_delete_policy: Output<Option<BucketSoftDeletePolicy>>,
    pub storage_class: Output<Option<String>>,
    pub uniform_bucket_level_access: Output<Option<bool>>,
    pub versioning: Output<Option<BucketVersioning>>,
    pub website: Output<Option<BucketWebsite>>,
}

Fields

autoclass: Output<Option<BucketAutoclass>>

The bucket’s Autoclass configuration. Structure is documented below.

cors: Output<Option<Vec<BucketCor>>>

The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.

custom_placement_config: Output<Option<BucketCustomPlacementConfig>>

The bucket’s custom location configuration, which specifies the individual regions that comprise a dual-region bucket. If the bucket is designated a single or multi-region, the parameters are empty. Structure is documented below.

default_event_based_hold: Output<Option<bool>>

Whether or not to automatically apply an eventBasedHold to new objects added to the bucket.

enable_object_retention: Output<Option<bool>>

Enables object retention on a storage bucket.

encryption: Output<Option<BucketEncryption>>

The bucket’s encryption configuration. Structure is documented below.

force_destroy: Output<Option<bool>>

When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.

hierarchical_namespace: Output<Option<BucketHierarchicalNamespace>>

The bucket’s hierarchical namespace policy, which defines the bucket capability to handle folders in logical structure. Structure is documented below. To use this configuration, uniform_bucket_level_access must be enabled on bucket.

labels: Output<Option<HashMap<String, String>>>

A map of key/value label pairs to assign to the bucket.

lifecycle_rules: Output<Option<Vec<BucketLifecycleRule>>>

The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.

location: Output<String>

The GCS location.

---

logging: Output<Option<BucketLogging>>

The bucket’s Access & Storage Logs configuration. Structure is documented below.

name: Output<Option<String>>

The name of the bucket.

project: Output<Option<String>>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

public_access_prevention: Output<Option<String>>

Prevents public access to a bucket. Acceptable values are “inherited” or “enforced”. If “inherited”, the bucket uses public access prevention. only if the bucket is subject to the public access prevention organization policy constraint. Defaults to “inherited”.

requester_pays: Output<Option<bool>>

Enables Requester Pays on a storage bucket.

retention_policy: Output<Option<BucketRetentionPolicy>>

Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.

rpo: Output<Option<String>>

The recovery point objective for cross-region replication of the bucket. Applicable only for dual and multi-region buckets. "DEFAULT" sets default replication. "ASYNC_TURBO" value enables turbo replication, valid for dual-region buckets only. See Turbo Replication for more information. If rpo is not specified at bucket creation, it defaults to "DEFAULT" for dual and multi-region buckets. NOTE If used with single-region bucket, It will throw an error.

soft_delete_policy: Output<Option<BucketSoftDeletePolicy>>

The bucket’s soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. If it is not provided, by default Google Cloud Storage sets this to default soft delete policy

storage_class: Output<Option<String>>

The Storage Class of the new bucket. Supported values include: STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.

uniform_bucket_level_access: Output<Option<bool>>

Enables Uniform bucket-level access access to a bucket.

versioning: Output<Option<BucketVersioning>>

The bucket’s Versioning configuration. Structure is documented below.

website: Output<Option<BucketWebsite>>

Configuration if the bucket acts as a website. Structure is documented below.

Implementations

impl BucketArgs

pub fn builder() -> BucketArgsBuilder

Create an instance of BucketArgs using the builder syntax

Trait Implementations

impl Clone for BucketArgs

fn clone(&self) -> BucketArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.