Package com.hashicorp.cdktf.providers.google.alloydb_backup

Class AlloydbBackup.Builder

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • backupId

        @Stability(Stable)
public AlloydbBackup.Builder backupId​(String backupId)
        The ID of the alloydb backup.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#backup_id AlloydbBackup#backup_id}

        Parameters:
        backupId - The ID of the alloydb backup. This parameter is required.
        Returns:
        this

      • clusterName

        @Stability(Stable)
public AlloydbBackup.Builder clusterName​(String clusterName)
        The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#cluster_name AlloydbBackup#cluster_name}

        Parameters:
        clusterName - The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}). This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public AlloydbBackup.Builder location​(String location)
        The location where the alloydb backup should reside.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#location AlloydbBackup#location}

        Parameters:
        location - The location where the alloydb backup should reside. This parameter is required.
        Returns:
        this

      • annotations

        @Stability(Stable)
public AlloydbBackup.Builder annotations​(Map<String,​String> annotations)
        Annotations to allow client tools to store small amount of arbitrary data.

        This is distinct from labels. https://google.aip.dev/128 An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#annotations AlloydbBackup#annotations}

        Parameters:
        annotations - Annotations to allow client tools to store small amount of arbitrary data. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public AlloydbBackup.Builder description​(String description)
        User-provided description of the backup.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#description AlloydbBackup#description}

        Parameters:
        description - User-provided description of the backup. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public AlloydbBackup.Builder displayName​(String displayName)
        User-settable and human-readable display name for the Backup.

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

        Parameters:
        displayName - User-settable and human-readable display name for the Backup. This parameter is required.
        Returns:
        this

      • encryptionConfig

        @Stability(Stable)
public AlloydbBackup.Builder encryptionConfig​(AlloydbBackupEncryptionConfig encryptionConfig)
        encryption_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#encryption_config AlloydbBackup#encryption_config}

        Parameters:
        encryptionConfig - encryption_config block. This parameter is required.
        Returns:
        this

      • id

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

      • labels

        @Stability(Stable)
public AlloydbBackup.Builder labels​(Map<String,​String> labels)
        User-defined labels for the alloydb backup.

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. **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/alloydb_backup#labels AlloydbBackup#labels}

        Parameters:
        labels - User-defined labels for the alloydb backup. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public AlloydbBackup.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#project AlloydbBackup#project}.

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

      • timeouts

        @Stability(Stable)
public AlloydbBackup.Builder timeouts​(AlloydbBackupTimeouts timeouts)
        timeouts block.

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

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

      • type

        @Stability(Stable)
public AlloydbBackup.Builder type​(String type)
        The backup type, which suggests the trigger for the backup. Possible values: ["TYPE_UNSPECIFIED", "ON_DEMAND", "AUTOMATED", "CONTINUOUS"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#type AlloydbBackup#type}

        Parameters:
        type - The backup type, which suggests the trigger for the backup. Possible values: ["TYPE_UNSPECIFIED", "ON_DEMAND", "AUTOMATED", "CONTINUOUS"]. This parameter is required.
        Returns:
        this