Package com.hashicorp.cdktf.providers.google.storage_bucket_object

Class StorageBucketObject.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static StorageBucketObject.Builder create​(software.constructs.Construct scope,
                                                 String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of StorageBucketObject.Builder.

      • connection

        @Stability(Experimental)
public StorageBucketObject.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public StorageBucketObject.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public StorageBucketObject.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public StorageBucketObject.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public StorageBucketObject.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public StorageBucketObject.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public StorageBucketObject.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public StorageBucketObject.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • bucket

        @Stability(Stable)
public StorageBucketObject.Builder bucket​(String bucket)
        The name of the containing bucket.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#bucket StorageBucketObject#bucket}

        Parameters:
        bucket - The name of the containing bucket. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public StorageBucketObject.Builder name​(String name)
        The name of the object. If you're interpolating the name of this object, see output_name instead.

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

        Parameters:
        name - The name of the object. If you're interpolating the name of this object, see output_name instead. This parameter is required.
        Returns:
        this

      • cacheControl

        @Stability(Stable)
public StorageBucketObject.Builder cacheControl​(String cacheControl)
        Cache-Control directive to specify caching behavior of object data.

        If omitted and object is accessible to all anonymous users, the default will be public, max-age=3600 Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#cache_control StorageBucketObject#cache_control}

        Parameters:
        cacheControl - Cache-Control directive to specify caching behavior of object data. This parameter is required.
        Returns:
        this

      • content

        @Stability(Stable)
public StorageBucketObject.Builder content​(String content)
        Data as string to be uploaded.

        Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content StorageBucketObject#content}

        Parameters:
        content - Data as string to be uploaded. This parameter is required.
        Returns:
        this

      • contentDisposition

        @Stability(Stable)
public StorageBucketObject.Builder contentDisposition​(String contentDisposition)
        Content-Disposition of the object data.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_disposition StorageBucketObject#content_disposition}

        Parameters:
        contentDisposition - Content-Disposition of the object data. This parameter is required.
        Returns:
        this

      • contentEncoding

        @Stability(Stable)
public StorageBucketObject.Builder contentEncoding​(String contentEncoding)
        Content-Encoding of the object data.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_encoding StorageBucketObject#content_encoding}

        Parameters:
        contentEncoding - Content-Encoding of the object data. This parameter is required.
        Returns:
        this

      • contentLanguage

        @Stability(Stable)
public StorageBucketObject.Builder contentLanguage​(String contentLanguage)
        Content-Language of the object data.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_language StorageBucketObject#content_language}

        Parameters:
        contentLanguage - Content-Language of the object data. This parameter is required.
        Returns:
        this

      • contentType

        @Stability(Stable)
public StorageBucketObject.Builder contentType​(String contentType)
        Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_type StorageBucketObject#content_type}

        Parameters:
        contentType - Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8". This parameter is required.
        Returns:
        this

      • customerEncryption

        @Stability(Stable)
public StorageBucketObject.Builder customerEncryption​(StorageBucketObjectCustomerEncryption customerEncryption)
        customer_encryption block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#customer_encryption StorageBucketObject#customer_encryption}

        Parameters:
        customerEncryption - customer_encryption block. This parameter is required.
        Returns:
        this

      • detectMd5Hash

        @Stability(Stable)
public StorageBucketObject.Builder detectMd5Hash​(String detectMd5Hash)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#detect_md5hash StorageBucketObject#detect_md5hash}.

        Parameters:
        detectMd5Hash - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#detect_md5hash StorageBucketObject#detect_md5hash}. This parameter is required.
        Returns:
        this

      • eventBasedHold

        @Stability(Stable)
public StorageBucketObject.Builder eventBasedHold​(Boolean eventBasedHold)
        Whether an object is under event-based hold.

        Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#event_based_hold StorageBucketObject#event_based_hold}

        Parameters:
        eventBasedHold - Whether an object is under event-based hold. This parameter is required.
        Returns:
        this

      • eventBasedHold

        @Stability(Stable)
public StorageBucketObject.Builder eventBasedHold​(com.hashicorp.cdktf.IResolvable eventBasedHold)
        Whether an object is under event-based hold.

        Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#event_based_hold StorageBucketObject#event_based_hold}

        Parameters:
        eventBasedHold - Whether an object is under event-based hold. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public StorageBucketObject.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#id StorageBucketObject#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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#id StorageBucketObject#id}. This parameter is required.
        Returns:
        this

      • kmsKeyName

        @Stability(Stable)
public StorageBucketObject.Builder kmsKeyName​(String kmsKeyName)
        Resource name of the Cloud KMS key that will be used to encrypt the object.

        Overrides the object metadata's kmsKeyName value, if any. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#kms_key_name StorageBucketObject#kms_key_name}

        Parameters:
        kmsKeyName - Resource name of the Cloud KMS key that will be used to encrypt the object. This parameter is required.
        Returns:
        this

      • metadata

        @Stability(Stable)
public StorageBucketObject.Builder metadata​(Map<String,​String> metadata)
        User-provided metadata, in key/value pairs.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#metadata StorageBucketObject#metadata}

        Parameters:
        metadata - User-provided metadata, in key/value pairs. This parameter is required.
        Returns:
        this

      • retention

        @Stability(Stable)
public StorageBucketObject.Builder retention​(StorageBucketObjectRetention retention)
        retention block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#retention StorageBucketObject#retention}

        Parameters:
        retention - retention block. This parameter is required.
        Returns:
        this

      • source

        @Stability(Stable)
public StorageBucketObject.Builder source​(String source)
        A path to the data you want to upload. Must be defined if content is not.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#source StorageBucketObject#source}

        Parameters:
        source - A path to the data you want to upload. Must be defined if content is not. This parameter is required.
        Returns:
        this

      • storageClass

        @Stability(Stable)
public StorageBucketObject.Builder storageClass​(String storageClass)
        The StorageClass of the new bucket object.

        Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE. If not provided, this defaults to the bucket's default storage class or to a standard class. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#storage_class StorageBucketObject#storage_class}

        Parameters:
        storageClass - The StorageClass of the new bucket object. This parameter is required.
        Returns:
        this

      • temporaryHold

        @Stability(Stable)
public StorageBucketObject.Builder temporaryHold​(Boolean temporaryHold)
        Whether an object is under temporary hold.

        While this flag is set to true, the object is protected against deletion and overwrites. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#temporary_hold StorageBucketObject#temporary_hold}

        Parameters:
        temporaryHold - Whether an object is under temporary hold. This parameter is required.
        Returns:
        this

      • temporaryHold

        @Stability(Stable)
public StorageBucketObject.Builder temporaryHold​(com.hashicorp.cdktf.IResolvable temporaryHold)
        Whether an object is under temporary hold.

        While this flag is set to true, the object is protected against deletion and overwrites. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#temporary_hold StorageBucketObject#temporary_hold}

        Parameters:
        temporaryHold - Whether an object is under temporary hold. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public StorageBucketObject.Builder timeouts​(StorageBucketObjectTimeouts timeouts)
        timeouts block.

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

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this