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

Interface BigtableTableConfig

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

    • Method Detail

      • getInstanceName

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

      • getName

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

      • getAutomatedBackupPolicy

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

      • getChangeStreamRetention

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

      • getColumnFamily

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

      • getDeletionProtection

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

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

      • 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_table#project BigtableTable#project}

      • getSplitKeys

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

      • getTimeouts

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

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