Package com.hashicorp.cdktf.providers.google.bigtable_gc_policy

Class BigtableGcPolicy.Builder

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • columnFamily

        @Stability(Stable)
public BigtableGcPolicy.Builder columnFamily​(String columnFamily)
        The name of the column family.

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

        Parameters:
        columnFamily - The name of the column family. This parameter is required.
        Returns:
        this

      • instanceName

        @Stability(Stable)
public BigtableGcPolicy.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_gc_policy#instance_name BigtableGcPolicy#instance_name}

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

      • table

        @Stability(Stable)
public BigtableGcPolicy.Builder table​(String table)
        The name of the table.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#table BigtableGcPolicy#table}

        Parameters:
        table - The name of the table. This parameter is required.
        Returns:
        this

      • deletionPolicy

        @Stability(Stable)
public BigtableGcPolicy.Builder deletionPolicy​(String deletionPolicy)
        The deletion policy for the GC policy.

        Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted in a replicated instance. Possible values are: "ABANDON". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#deletion_policy BigtableGcPolicy#deletion_policy}

        Parameters:
        deletionPolicy - The deletion policy for the GC policy. This parameter is required.
        Returns:
        this

      • gcRules

        @Stability(Stable)
public BigtableGcPolicy.Builder gcRules​(String gcRules)
        Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#gc_rules BigtableGcPolicy#gc_rules}

        Parameters:
        gcRules - Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version". This parameter is required.
        Returns:
        this

      • id

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

      • ignoreWarnings

        @Stability(Stable)
public BigtableGcPolicy.Builder ignoreWarnings​(Boolean ignoreWarnings)
        Allows ignoring warnings when updating the GC policy.

        This can be used to increase the gc policy on replicated clusters. Doing this may make clusters be inconsistent for a longer period of time, before using this make sure you understand the risks listed at https://cloud.google.com/bigtable/docs/garbage-collection#increasing Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#ignore_warnings BigtableGcPolicy#ignore_warnings}

        Parameters:
        ignoreWarnings - Allows ignoring warnings when updating the GC policy. This parameter is required.
        Returns:
        this

      • ignoreWarnings

        @Stability(Stable)
public BigtableGcPolicy.Builder ignoreWarnings​(com.hashicorp.cdktf.IResolvable ignoreWarnings)
        Allows ignoring warnings when updating the GC policy.

        This can be used to increase the gc policy on replicated clusters. Doing this may make clusters be inconsistent for a longer period of time, before using this make sure you understand the risks listed at https://cloud.google.com/bigtable/docs/garbage-collection#increasing Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#ignore_warnings BigtableGcPolicy#ignore_warnings}

        Parameters:
        ignoreWarnings - Allows ignoring warnings when updating the GC policy. This parameter is required.
        Returns:
        this

      • maxAge

        @Stability(Stable)
public BigtableGcPolicy.Builder maxAge​(BigtableGcPolicyMaxAge maxAge)
        max_age block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#max_age BigtableGcPolicy#max_age}

        Parameters:
        maxAge - max_age block. This parameter is required.
        Returns:
        this

      • maxVersion

        @Stability(Stable)
public BigtableGcPolicy.Builder maxVersion​(com.hashicorp.cdktf.IResolvable maxVersion)
        max_version block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#max_version BigtableGcPolicy#max_version}

        Parameters:
        maxVersion - max_version block. This parameter is required.
        Returns:
        this

      • maxVersion

        @Stability(Stable)
public BigtableGcPolicy.Builder maxVersion​(List<? extends BigtableGcPolicyMaxVersion> maxVersion)
        max_version block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#max_version BigtableGcPolicy#max_version}

        Parameters:
        maxVersion - max_version block. This parameter is required.
        Returns:
        this

      • mode

        @Stability(Stable)
public BigtableGcPolicy.Builder mode​(String mode)
        NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources.

        This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigtable_gc_policy#mode BigtableGcPolicy#mode}

        Parameters:
        mode - NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This parameter is required.
        Returns:
        this

      • project

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

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

      • timeouts

        @Stability(Stable)
public BigtableGcPolicy.Builder timeouts​(BigtableGcPolicyTimeouts timeouts)
        timeouts block.

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

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