Package com.hashicorp.cdktf.providers.google.storage_bucket

Interface StorageBucketConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    StorageBucketConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.820Z")
@Stability(Stable)
public interface StorageBucketConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        The Google Cloud Storage location.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#location StorageBucket#location}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The name of the bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#name StorageBucket#name}

      • getAutoclass

        @Stability(Stable)
@Nullable
default StorageBucketAutoclass getAutoclass()
        autoclass block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#autoclass StorageBucket#autoclass}

      • getCors

        @Stability(Stable)
@Nullable
default Object getCors()
        cors block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#cors StorageBucket#cors}

      • getCustomPlacementConfig

        @Stability(Stable)
@Nullable
default StorageBucketCustomPlacementConfig getCustomPlacementConfig()
        custom_placement_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#custom_placement_config StorageBucket#custom_placement_config}

      • getDefaultEventBasedHold

        @Stability(Stable)
@Nullable
default Object getDefaultEventBasedHold()
        Whether or not to automatically apply an eventBasedHold to new objects added to the bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#default_event_based_hold StorageBucket#default_event_based_hold}

      • getEnableObjectRetention

        @Stability(Stable)
@Nullable
default Object getEnableObjectRetention()
        Enables each object in the bucket to have its own retention policy, which prevents deletion until stored for a specific length of time.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#enable_object_retention StorageBucket#enable_object_retention}

      • getEncryption

        @Stability(Stable)
@Nullable
default StorageBucketEncryption getEncryption()
        encryption block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#encryption StorageBucket#encryption}

      • getForceDestroy

        @Stability(Stable)
@Nullable
default Object getForceDestroy()
        When deleting a bucket, this boolean option will delete all contained objects.

        If you try to delete a bucket that contains objects, Terraform will fail that run. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#force_destroy StorageBucket#force_destroy}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#id StorageBucket#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        A set of key/value label pairs to assign to the bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#labels StorageBucket#labels}

      • getLifecycleRule

        @Stability(Stable)
@Nullable
default Object getLifecycleRule()
        lifecycle_rule block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#lifecycle_rule StorageBucket#lifecycle_rule}

      • getLogging

        @Stability(Stable)
@Nullable
default StorageBucketLogging getLogging()
        logging block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#logging StorageBucket#logging}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        The ID of the project in which the resource belongs.

        If it is not provided, the provider project is used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#project StorageBucket#project}

      • getPublicAccessPrevention

        @Stability(Stable)
@Nullable
default String getPublicAccessPrevention()
        Prevents public access to a bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#public_access_prevention StorageBucket#public_access_prevention}

      • getRequesterPays

        @Stability(Stable)
@Nullable
default Object getRequesterPays()
        Enables Requester Pays on a storage bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#requester_pays StorageBucket#requester_pays}

      • getRetentionPolicy

        @Stability(Stable)
@Nullable
default StorageBucketRetentionPolicy getRetentionPolicy()
        retention_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#retention_policy StorageBucket#retention_policy}

      • getRpo

        @Stability(Stable)
@Nullable
default String getRpo()
        Specifies the RPO setting of bucket.

        If set 'ASYNC_TURBO', The Turbo Replication will be enabled for the dual-region bucket. Value 'DEFAULT' will set RPO setting to default. Turbo Replication is only for buckets in dual-regions.See the docs for more details. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#rpo StorageBucket#rpo}

      • getSoftDeletePolicy

        @Stability(Stable)
@Nullable
default StorageBucketSoftDeletePolicy getSoftDeletePolicy()
        soft_delete_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#soft_delete_policy StorageBucket#soft_delete_policy}

      • getStorageClass

        @Stability(Stable)
@Nullable
default String getStorageClass()
        The Storage Class of the new bucket. Supported values include: STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#storage_class StorageBucket#storage_class}

      • getTimeouts

        @Stability(Stable)
@Nullable
default StorageBucketTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#timeouts StorageBucket#timeouts}

      • getUniformBucketLevelAccess

        @Stability(Stable)
@Nullable
default Object getUniformBucketLevelAccess()
        Enables uniform bucket-level access on a bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#uniform_bucket_level_access StorageBucket#uniform_bucket_level_access}

      • getVersioning

        @Stability(Stable)
@Nullable
default StorageBucketVersioning getVersioning()
        versioning block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#versioning StorageBucket#versioning}

      • getWebsite

        @Stability(Stable)
@Nullable
default StorageBucketWebsite getWebsite()
        website block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket#website StorageBucket#website}