Package com.hashicorp.cdktf.providers.google.bigtable_instance

Interface BigtableInstanceConfig

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

    • Method Detail

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

        Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_instance#name BigtableInstance#name}

      • getCluster

        @Stability(Stable)
@Nullable
default Object getCluster()
        cluster block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_instance#cluster BigtableInstance#cluster}

      • getDeletionProtection

        @Stability(Stable)
@Nullable
default Object getDeletionProtection()
        When the field is set to true or unset in Terraform state, a terraform apply or terraform destroy that would delete the instance will fail.

        When the field is set to false, deleting the instance is allowed. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_instance#deletion_protection BigtableInstance#deletion_protection}

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        The human-readable display name of the Bigtable instance. Defaults to the instance name.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_instance#display_name BigtableInstance#display_name}

      • getForceDestroy

        @Stability(Stable)
@Nullable
default Object getForceDestroy()
        When deleting a BigTable instance, this boolean option will delete all backups within the instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_instance#force_destroy BigtableInstance#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/bigtable_instance#id BigtableInstance#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.

      • getInstanceType

        @Stability(Stable)
@Nullable
default String getInstanceType()
        The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_instance#instance_type BigtableInstance#instance_type}

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        A mapping of labels to assign to the resource.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_instance#labels BigtableInstance#labels}

      • 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/bigtable_instance#project BigtableInstance#project}

      • getTimeouts

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

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