Class AlloydbBackupConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.alloydb_backup.AlloydbBackupConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<AlloydbBackupConfig>
- Enclosing interface:
- AlloydbBackupConfig
@Stability(Stable) public static final class AlloydbBackupConfig.Builder extends Object implements software.amazon.jsii.Builder<AlloydbBackupConfig>
A builder forAlloydbBackupConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AlloydbBackupConfig.Builderannotations(Map<String,String> annotations)Sets the value ofAlloydbBackupConfig.getAnnotations()AlloydbBackupConfig.BuilderbackupId(String backupId)Sets the value ofAlloydbBackupConfig.getBackupId()AlloydbBackupConfigbuild()Builds the configured instance.AlloydbBackupConfig.BuilderclusterName(String clusterName)Sets the value ofAlloydbBackupConfig.getClusterName()AlloydbBackupConfig.Builderconnection(com.hashicorp.cdktf.SSHProvisionerConnection connection)Sets the value ofTerraformMetaArguments.getConnection()AlloydbBackupConfig.Builderconnection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)Sets the value ofTerraformMetaArguments.getConnection()AlloydbBackupConfig.Buildercount(com.hashicorp.cdktf.TerraformCount count)Sets the value ofTerraformMetaArguments.getCount()AlloydbBackupConfig.Buildercount(Number count)Sets the value ofTerraformMetaArguments.getCount()AlloydbBackupConfig.BuilderdependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)Sets the value ofTerraformMetaArguments.getDependsOn()AlloydbBackupConfig.Builderdescription(String description)Sets the value ofAlloydbBackupConfig.getDescription()AlloydbBackupConfig.BuilderdisplayName(String displayName)Sets the value ofAlloydbBackupConfig.getDisplayName()AlloydbBackupConfig.BuilderencryptionConfig(AlloydbBackupEncryptionConfig encryptionConfig)Sets the value ofAlloydbBackupConfig.getEncryptionConfig()AlloydbBackupConfig.BuilderforEach(com.hashicorp.cdktf.ITerraformIterator forEach)Sets the value ofTerraformMetaArguments.getForEach()AlloydbBackupConfig.Builderid(String id)Sets the value ofAlloydbBackupConfig.getId()AlloydbBackupConfig.Builderlabels(Map<String,String> labels)Sets the value ofAlloydbBackupConfig.getLabels()AlloydbBackupConfig.Builderlifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)Sets the value ofTerraformMetaArguments.getLifecycle()AlloydbBackupConfig.Builderlocation(String location)Sets the value ofAlloydbBackupConfig.getLocation()AlloydbBackupConfig.Builderproject(String project)Sets the value ofAlloydbBackupConfig.getProject()AlloydbBackupConfig.Builderprovider(com.hashicorp.cdktf.TerraformProvider provider)Sets the value ofTerraformMetaArguments.getProvider()AlloydbBackupConfig.Builderprovisioners(List<? extends Object> provisioners)Sets the value ofTerraformMetaArguments.getProvisioners()AlloydbBackupConfig.Buildertimeouts(AlloydbBackupTimeouts timeouts)Sets the value ofAlloydbBackupConfig.getTimeouts()AlloydbBackupConfig.Buildertype(String type)Sets the value ofAlloydbBackupConfig.getType()
-
-
-
Method Detail
-
backupId
@Stability(Stable) public AlloydbBackupConfig.Builder backupId(String backupId)
Sets the value ofAlloydbBackupConfig.getBackupId()- Parameters:
backupId- The ID of the alloydb backup. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#backup_id AlloydbBackup#backup_id}- Returns:
this
-
clusterName
@Stability(Stable) public AlloydbBackupConfig.Builder clusterName(String clusterName)
Sets the value ofAlloydbBackupConfig.getClusterName()- Parameters:
clusterName- The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}). This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#cluster_name AlloydbBackup#cluster_name}- Returns:
this
-
location
@Stability(Stable) public AlloydbBackupConfig.Builder location(String location)
Sets the value ofAlloydbBackupConfig.getLocation()- Parameters:
location- The location where the alloydb backup should reside. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#location AlloydbBackup#location}- Returns:
this
-
annotations
@Stability(Stable) public AlloydbBackupConfig.Builder annotations(Map<String,String> annotations)
Sets the value ofAlloydbBackupConfig.getAnnotations()- Parameters:
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}- Returns:
this
-
description
@Stability(Stable) public AlloydbBackupConfig.Builder description(String description)
Sets the value ofAlloydbBackupConfig.getDescription()- Parameters:
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}- Returns:
this
-
displayName
@Stability(Stable) public AlloydbBackupConfig.Builder displayName(String displayName)
Sets the value ofAlloydbBackupConfig.getDisplayName()- Parameters:
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}- Returns:
this
-
encryptionConfig
@Stability(Stable) public AlloydbBackupConfig.Builder encryptionConfig(AlloydbBackupEncryptionConfig encryptionConfig)
Sets the value ofAlloydbBackupConfig.getEncryptionConfig()- Parameters:
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}- Returns:
this
-
id
@Stability(Stable) public AlloydbBackupConfig.Builder id(String id)
Sets the value ofAlloydbBackupConfig.getId()- Parameters:
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.- Returns:
this
-
labels
@Stability(Stable) public AlloydbBackupConfig.Builder labels(Map<String,String> labels)
Sets the value ofAlloydbBackupConfig.getLabels()- Parameters:
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}- Returns:
this
-
project
@Stability(Stable) public AlloydbBackupConfig.Builder project(String project)
Sets the value ofAlloydbBackupConfig.getProject()- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#project AlloydbBackup#project}.- Returns:
this
-
timeouts
@Stability(Stable) public AlloydbBackupConfig.Builder timeouts(AlloydbBackupTimeouts timeouts)
Sets the value ofAlloydbBackupConfig.getTimeouts()- Parameters:
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}- Returns:
this
-
type
@Stability(Stable) public AlloydbBackupConfig.Builder type(String type)
Sets the value ofAlloydbBackupConfig.getType()- Parameters:
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}- Returns:
this
-
connection
@Stability(Experimental) public AlloydbBackupConfig.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
connection
@Stability(Experimental) public AlloydbBackupConfig.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public AlloydbBackupConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public AlloydbBackupConfig.Builder count(com.hashicorp.cdktf.TerraformCount count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
dependsOn
@Stability(Experimental) public AlloydbBackupConfig.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
Sets the value ofTerraformMetaArguments.getDependsOn()- Parameters:
dependsOn- the value to be set.- Returns:
this
-
forEach
@Stability(Experimental) public AlloydbBackupConfig.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
Sets the value ofTerraformMetaArguments.getForEach()- Parameters:
forEach- the value to be set.- Returns:
this
-
lifecycle
@Stability(Experimental) public AlloydbBackupConfig.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
Sets the value ofTerraformMetaArguments.getLifecycle()- Parameters:
lifecycle- the value to be set.- Returns:
this
-
provider
@Stability(Experimental) public AlloydbBackupConfig.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
Sets the value ofTerraformMetaArguments.getProvider()- Parameters:
provider- the value to be set.- Returns:
this
-
provisioners
@Stability(Experimental) public AlloydbBackupConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public AlloydbBackupConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<AlloydbBackupConfig>- Returns:
- a new instance of
AlloydbBackupConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-