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

Class BigtableInstance.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static BigtableInstance.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 BigtableInstance.Builder.

      • connection

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

      • connection

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

      • count

        @Stability(Experimental)
public BigtableInstance.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • name

        @Stability(Stable)
public BigtableInstance.Builder name​(String name)
        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}

        Parameters:
        name - The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. This parameter is required.
        Returns:
        this

      • cluster

        @Stability(Stable)
public BigtableInstance.Builder cluster​(com.hashicorp.cdktf.IResolvable cluster)
        cluster block.

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

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

      • cluster

        @Stability(Stable)
public BigtableInstance.Builder cluster​(List<? extends BigtableInstanceCluster> cluster)
        cluster block.

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

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

      • deletionProtection

        @Stability(Stable)
public BigtableInstance.Builder deletionProtection​(Boolean deletionProtection)
        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}

        Parameters:
        deletionProtection - 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. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public BigtableInstance.Builder deletionProtection​(com.hashicorp.cdktf.IResolvable deletionProtection)
        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}

        Parameters:
        deletionProtection - 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. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public BigtableInstance.Builder displayName​(String displayName)
        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}

        Parameters:
        displayName - The human-readable display name of the Bigtable instance. Defaults to the instance name. This parameter is required.
        Returns:
        this

      • forceDestroy

        @Stability(Stable)
public BigtableInstance.Builder forceDestroy​(Boolean forceDestroy)
        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}

        Parameters:
        forceDestroy - When deleting a BigTable instance, this boolean option will delete all backups within the instance. This parameter is required.
        Returns:
        this

      • forceDestroy

        @Stability(Stable)
public BigtableInstance.Builder forceDestroy​(com.hashicorp.cdktf.IResolvable forceDestroy)
        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}

        Parameters:
        forceDestroy - When deleting a BigTable instance, this boolean option will delete all backups within the instance. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public BigtableInstance.Builder id​(String id)
        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.

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

      • instanceType

        @Stability(Stable)
public BigtableInstance.Builder instanceType​(String instanceType)
        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}

        Parameters:
        instanceType - The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION". This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public BigtableInstance.Builder labels​(Map<String,​String> labels)
        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}

        Parameters:
        labels - A mapping of labels to assign to the resource. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public BigtableInstance.Builder project​(String project)
        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}

        Parameters:
        project - The ID of the project in which the resource belongs. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public BigtableInstance.Builder timeouts​(BigtableInstanceTimeouts timeouts)
        timeouts block.

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

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