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

Interface StorageBucketObjectConfig

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

    • Method Detail

      • getBucket

        @Stability(Stable)
@NotNull
String getBucket()
        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}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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}

      • getCacheControl

        @Stability(Stable)
@Nullable
default String getCacheControl()
        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}

      • getContent

        @Stability(Stable)
@Nullable
default String getContent()
        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}

      • getContentDisposition

        @Stability(Stable)
@Nullable
default String getContentDisposition()
        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}

      • getContentEncoding

        @Stability(Stable)
@Nullable
default String getContentEncoding()
        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}

      • getContentLanguage

        @Stability(Stable)
@Nullable
default String getContentLanguage()
        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}

      • getContentType

        @Stability(Stable)
@Nullable
default String getContentType()
        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}

      • getCustomerEncryption

        @Stability(Stable)
@Nullable
default StorageBucketObjectCustomerEncryption getCustomerEncryption()
        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}

      • getDetectMd5Hash

        @Stability(Stable)
@Nullable
default String getDetectMd5Hash()
        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}.

      • getEventBasedHold

        @Stability(Stable)
@Nullable
default Object getEventBasedHold()
        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}

      • 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_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.

      • getKmsKeyName

        @Stability(Stable)
@Nullable
default String getKmsKeyName()
        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}

      • getMetadata

        @Stability(Stable)
@Nullable
default Map<String,​String> getMetadata()
        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}

      • getRetention

        @Stability(Stable)
@Nullable
default StorageBucketObjectRetention getRetention()
        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}

      • getSource

        @Stability(Stable)
@Nullable
default String getSource()
        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}

      • getStorageClass

        @Stability(Stable)
@Nullable
default String getStorageClass()
        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}

      • getTemporaryHold

        @Stability(Stable)
@Nullable
default Object getTemporaryHold()
        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}

      • getTimeouts

        @Stability(Stable)
@Nullable
default StorageBucketObjectTimeouts getTimeouts()
        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}