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

Class StorageBucket

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.817Z")
@Stability(Stable)
public class StorageBucket
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket google_storage_bucket}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • StorageBucket

        protected StorageBucket​(software.amazon.jsii.JsiiObjectRef objRef)

      • StorageBucket

        protected StorageBucket​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • StorageBucket

        @Stability(Stable)
public StorageBucket​(@NotNull
                     software.constructs.Construct scope,
                     @NotNull
                     String id,
                     @NotNull
                     StorageBucketConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket google_storage_bucket} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a StorageBucket resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the StorageBucket to import. This parameter is required.
        importFromId - The id of the existing StorageBucket that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the StorageBucket to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a StorageBucket resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the StorageBucket to import. This parameter is required.
        importFromId - The id of the existing StorageBucket that should be imported. This parameter is required.

      • putAutoclass

        @Stability(Stable)
public void putAutoclass​(@NotNull
                         StorageBucketAutoclass value)
        Parameters:
        value - This parameter is required.

      • putCors

        @Stability(Stable)
public void putCors​(@NotNull
                    Object value)
        Parameters:
        value - This parameter is required.

      • putCustomPlacementConfig

        @Stability(Stable)
public void putCustomPlacementConfig​(@NotNull
                                     StorageBucketCustomPlacementConfig value)
        Parameters:
        value - This parameter is required.

      • putEncryption

        @Stability(Stable)
public void putEncryption​(@NotNull
                          StorageBucketEncryption value)
        Parameters:
        value - This parameter is required.

      • putLifecycleRule

        @Stability(Stable)
public void putLifecycleRule​(@NotNull
                             Object value)
        Parameters:
        value - This parameter is required.

      • putLogging

        @Stability(Stable)
public void putLogging​(@NotNull
                       StorageBucketLogging value)
        Parameters:
        value - This parameter is required.

      • putRetentionPolicy

        @Stability(Stable)
public void putRetentionPolicy​(@NotNull
                               StorageBucketRetentionPolicy value)
        Parameters:
        value - This parameter is required.

      • putSoftDeletePolicy

        @Stability(Stable)
public void putSoftDeletePolicy​(@NotNull
                                StorageBucketSoftDeletePolicy value)
        Parameters:
        value - This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        StorageBucketTimeouts value)
        Parameters:
        value - This parameter is required.

      • putVersioning

        @Stability(Stable)
public void putVersioning​(@NotNull
                          StorageBucketVersioning value)
        Parameters:
        value - This parameter is required.

      • putWebsite

        @Stability(Stable)
public void putWebsite​(@NotNull
                       StorageBucketWebsite value)
        Parameters:
        value - This parameter is required.

      • resetAutoclass

        @Stability(Stable)
public void resetAutoclass()

      • resetCors

        @Stability(Stable)
public void resetCors()

      • resetCustomPlacementConfig

        @Stability(Stable)
public void resetCustomPlacementConfig()

      • resetDefaultEventBasedHold

        @Stability(Stable)
public void resetDefaultEventBasedHold()

      • resetEnableObjectRetention

        @Stability(Stable)
public void resetEnableObjectRetention()

      • resetEncryption

        @Stability(Stable)
public void resetEncryption()

      • resetForceDestroy

        @Stability(Stable)
public void resetForceDestroy()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetLifecycleRule

        @Stability(Stable)
public void resetLifecycleRule()

      • resetLogging

        @Stability(Stable)
public void resetLogging()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetPublicAccessPrevention

        @Stability(Stable)
public void resetPublicAccessPrevention()

      • resetRequesterPays

        @Stability(Stable)
public void resetRequesterPays()

      • resetRetentionPolicy

        @Stability(Stable)
public void resetRetentionPolicy()

      • resetRpo

        @Stability(Stable)
public void resetRpo()

      • resetSoftDeletePolicy

        @Stability(Stable)
public void resetSoftDeletePolicy()

      • resetStorageClass

        @Stability(Stable)
public void resetStorageClass()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • resetUniformBucketLevelAccess

        @Stability(Stable)
public void resetUniformBucketLevelAccess()

      • resetVersioning

        @Stability(Stable)
public void resetVersioning()

      • resetWebsite

        @Stability(Stable)
public void resetWebsite()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getEffectiveLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveLabels()

      • getProjectNumber

        @Stability(Stable)
@NotNull
public Number getProjectNumber()

      • getSelfLink

        @Stability(Stable)
@NotNull
public String getSelfLink()

      • getTerraformLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getTerraformLabels()

      • getUrl

        @Stability(Stable)
@NotNull
public String getUrl()

      • getCorsInput

        @Stability(Stable)
@Nullable
public Object getCorsInput()

      • getDefaultEventBasedHoldInput

        @Stability(Stable)
@Nullable
public Object getDefaultEventBasedHoldInput()

      • getEnableObjectRetentionInput

        @Stability(Stable)
@Nullable
public Object getEnableObjectRetentionInput()

      • getForceDestroyInput

        @Stability(Stable)
@Nullable
public Object getForceDestroyInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getLabelsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getLabelsInput()

      • getLifecycleRuleInput

        @Stability(Stable)
@Nullable
public Object getLifecycleRuleInput()

      • getLocationInput

        @Stability(Stable)
@Nullable
public String getLocationInput()

      • getNameInput

        @Stability(Stable)
@Nullable
public String getNameInput()

      • getProjectInput

        @Stability(Stable)
@Nullable
public String getProjectInput()

      • getPublicAccessPreventionInput

        @Stability(Stable)
@Nullable
public String getPublicAccessPreventionInput()

      • getRequesterPaysInput

        @Stability(Stable)
@Nullable
public Object getRequesterPaysInput()

      • getRpoInput

        @Stability(Stable)
@Nullable
public String getRpoInput()

      • getStorageClassInput

        @Stability(Stable)
@Nullable
public String getStorageClassInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getUniformBucketLevelAccessInput

        @Stability(Stable)
@Nullable
public Object getUniformBucketLevelAccessInput()

      • getDefaultEventBasedHold

        @Stability(Stable)
@NotNull
public Object getDefaultEventBasedHold()

      • setDefaultEventBasedHold

        @Stability(Stable)
public void setDefaultEventBasedHold​(@NotNull
                                     Boolean value)

      • setDefaultEventBasedHold

        @Stability(Stable)
public void setDefaultEventBasedHold​(@NotNull
                                     com.hashicorp.cdktf.IResolvable value)

      • getEnableObjectRetention

        @Stability(Stable)
@NotNull
public Object getEnableObjectRetention()

      • setEnableObjectRetention

        @Stability(Stable)
public void setEnableObjectRetention​(@NotNull
                                     Boolean value)

      • setEnableObjectRetention

        @Stability(Stable)
public void setEnableObjectRetention​(@NotNull
                                     com.hashicorp.cdktf.IResolvable value)

      • getForceDestroy

        @Stability(Stable)
@NotNull
public Object getForceDestroy()

      • setForceDestroy

        @Stability(Stable)
public void setForceDestroy​(@NotNull
                            Boolean value)

      • setForceDestroy

        @Stability(Stable)
public void setForceDestroy​(@NotNull
                            com.hashicorp.cdktf.IResolvable value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getLabels

        @Stability(Stable)
@NotNull
public Map<String,​String> getLabels()

      • setLabels

        @Stability(Stable)
public void setLabels​(@NotNull
                      Map<String,​String> value)

      • getLocation

        @Stability(Stable)
@NotNull
public String getLocation()

      • setLocation

        @Stability(Stable)
public void setLocation​(@NotNull
                        String value)

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • setName

        @Stability(Stable)
public void setName​(@NotNull
                    String value)

      • getProject

        @Stability(Stable)
@NotNull
public String getProject()

      • setProject

        @Stability(Stable)
public void setProject​(@NotNull
                       String value)

      • getPublicAccessPrevention

        @Stability(Stable)
@NotNull
public String getPublicAccessPrevention()

      • setPublicAccessPrevention

        @Stability(Stable)
public void setPublicAccessPrevention​(@NotNull
                                      String value)

      • getRequesterPays

        @Stability(Stable)
@NotNull
public Object getRequesterPays()

      • setRequesterPays

        @Stability(Stable)
public void setRequesterPays​(@NotNull
                             Boolean value)

      • setRequesterPays

        @Stability(Stable)
public void setRequesterPays​(@NotNull
                             com.hashicorp.cdktf.IResolvable value)

      • getRpo

        @Stability(Stable)
@NotNull
public String getRpo()

      • setRpo

        @Stability(Stable)
public void setRpo​(@NotNull
                   String value)

      • getStorageClass

        @Stability(Stable)
@NotNull
public String getStorageClass()

      • setStorageClass

        @Stability(Stable)
public void setStorageClass​(@NotNull
                            String value)

      • getUniformBucketLevelAccess

        @Stability(Stable)
@NotNull
public Object getUniformBucketLevelAccess()

      • setUniformBucketLevelAccess

        @Stability(Stable)
public void setUniformBucketLevelAccess​(@NotNull
                                        Boolean value)

      • setUniformBucketLevelAccess

        @Stability(Stable)
public void setUniformBucketLevelAccess​(@NotNull
                                        com.hashicorp.cdktf.IResolvable value)