Package com.hashicorp.cdktf.providers.google.bigtable_table

Class BigtableTable.Builder

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • instanceName

        @Stability(Stable)
public BigtableTable.Builder instanceName​(String instanceName)
        The name of the Bigtable instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#instance_name BigtableTable#instance_name}

        Parameters:
        instanceName - The name of the Bigtable instance. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public BigtableTable.Builder name​(String name)
        The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.

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

        Parameters:
        name - The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers. This parameter is required.
        Returns:
        this

      • automatedBackupPolicy

        @Stability(Stable)
public BigtableTable.Builder automatedBackupPolicy​(BigtableTableAutomatedBackupPolicy automatedBackupPolicy)
        automated_backup_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#automated_backup_policy BigtableTable#automated_backup_policy}

        Parameters:
        automatedBackupPolicy - automated_backup_policy block. This parameter is required.
        Returns:
        this

      • changeStreamRetention

        @Stability(Stable)
public BigtableTable.Builder changeStreamRetention​(String changeStreamRetention)
        Duration to retain change stream data for the table.

        Set to 0 to disable. Must be between 1 and 7 days. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#change_stream_retention BigtableTable#change_stream_retention}

        Parameters:
        changeStreamRetention - Duration to retain change stream data for the table. This parameter is required.
        Returns:
        this

      • columnFamily

        @Stability(Stable)
public BigtableTable.Builder columnFamily​(com.hashicorp.cdktf.IResolvable columnFamily)
        column_family block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#column_family BigtableTable#column_family}

        Parameters:
        columnFamily - column_family block. This parameter is required.
        Returns:
        this

      • columnFamily

        @Stability(Stable)
public BigtableTable.Builder columnFamily​(List<? extends BigtableTableColumnFamily> columnFamily)
        column_family block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#column_family BigtableTable#column_family}

        Parameters:
        columnFamily - column_family block. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public BigtableTable.Builder deletionProtection​(String deletionProtection)
        A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, currently deletion protection will be set to UNPROTECTED as it is the API default value.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#deletion_protection BigtableTable#deletion_protection}

        Parameters:
        deletionProtection - A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, currently deletion protection will be set to UNPROTECTED as it is the API default value. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public BigtableTable.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#id BigtableTable#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_table#id BigtableTable#id}. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public BigtableTable.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_table#project BigtableTable#project}

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

      • splitKeys

        @Stability(Stable)
public BigtableTable.Builder splitKeys​(List<String> splitKeys)
        A list of predefined keys to split the table on.

        !> Warning: Modifying the split_keys of an existing table will cause Terraform to delete/recreate the entire google_bigtable_table resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_table#split_keys BigtableTable#split_keys}

        Parameters:
        splitKeys - A list of predefined keys to split the table on. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public BigtableTable.Builder timeouts​(BigtableTableTimeouts timeouts)
        timeouts block.

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

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