Interface DBClusterAutomatedBackup.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DBClusterAutomatedBackup.Builder,
,DBClusterAutomatedBackup> SdkBuilder<DBClusterAutomatedBackup.Builder,
,DBClusterAutomatedBackup> SdkPojo
- Enclosing class:
DBClusterAutomatedBackup
-
Method Summary
Modifier and TypeMethodDescriptionallocatedStorage
(Integer allocatedStorage) For all database engines except Amazon Aurora,AllocatedStorage
specifies the allocated storage size in gibibytes (GiB).availabilityZones
(String... availabilityZones) The Availability Zones where instances in the DB cluster can be created.availabilityZones
(Collection<String> availabilityZones) The Availability Zones where instances in the DB cluster can be created.awsBackupRecoveryPointArn
(String awsBackupRecoveryPointArn) The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.backupRetentionPeriod
(Integer backupRetentionPeriod) The retention period for the automated backups.clusterCreateTime
(Instant clusterCreateTime) The time when the DB cluster was created, in Universal Coordinated Time (UTC).dbClusterArn
(String dbClusterArn) The Amazon Resource Name (ARN) for the source DB cluster.dbClusterAutomatedBackupsArn
(String dbClusterAutomatedBackupsArn) The Amazon Resource Name (ARN) for the automated backups.dbClusterIdentifier
(String dbClusterIdentifier) The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.dbClusterResourceId
(String dbClusterResourceId) The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.The name of the database engine for this automated backup.engineMode
(String engineMode) The engine mode of the database engine for the automated backup.engineVersion
(String engineVersion) The version of the database engine for the automated backup.iamDatabaseAuthenticationEnabled
(Boolean iamDatabaseAuthenticationEnabled) Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.The IOPS (I/O operations per second) value for the automated backup.The Amazon Web Services KMS key ID for an automated backup.licenseModel
(String licenseModel) The license model information for this DB cluster automated backup.masterUsername
(String masterUsername) The master user name of the automated backup.The port number that the automated backup used for connections.The Amazon Web Services Region associated with the automated backup.default DBClusterAutomatedBackup.Builder
restoreWindow
(Consumer<RestoreWindow.Builder> restoreWindow) Sets the value of the RestoreWindow property for this object.restoreWindow
(RestoreWindow restoreWindow) Sets the value of the RestoreWindow property for this object.A list of status information for an automated backup:storageEncrypted
(Boolean storageEncrypted) Indicates whether the source DB cluster is encrypted.storageThroughput
(Integer storageThroughput) The storage throughput for the automated backup.storageType
(String storageType) The storage type associated with the DB cluster.The VPC ID associated with the DB cluster.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
engine
The name of the database engine for this automated backup.
- Parameters:
engine
- The name of the database engine for this automated backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcId
The VPC ID associated with the DB cluster.
- Parameters:
vpcId
- The VPC ID associated with the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterAutomatedBackupsArn
The Amazon Resource Name (ARN) for the automated backups.
- Parameters:
dbClusterAutomatedBackupsArn
- The Amazon Resource Name (ARN) for the automated backups.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterIdentifier
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
- Parameters:
dbClusterIdentifier
- The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restoreWindow
Sets the value of the RestoreWindow property for this object.- Parameters:
restoreWindow
- The new value for the RestoreWindow property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restoreWindow
default DBClusterAutomatedBackup.Builder restoreWindow(Consumer<RestoreWindow.Builder> restoreWindow) Sets the value of the RestoreWindow property for this object. This is a convenience method that creates an instance of theRestoreWindow.Builder
avoiding the need to create one manually viaRestoreWindow.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torestoreWindow(RestoreWindow)
.- Parameters:
restoreWindow
- a consumer that will call methods onRestoreWindow.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
masterUsername
The master user name of the automated backup.
- Parameters:
masterUsername
- The master user name of the automated backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterResourceId
The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
- Parameters:
dbClusterResourceId
- The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
region
The Amazon Web Services Region associated with the automated backup.
- Parameters:
region
- The Amazon Web Services Region associated with the automated backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
licenseModel
The license model information for this DB cluster automated backup.
- Parameters:
licenseModel
- The license model information for this DB cluster automated backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
A list of status information for an automated backup:
-
retained
- Automated backups for deleted clusters.
- Parameters:
status
- A list of status information for an automated backup:-
retained
- Automated backups for deleted clusters.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
iamDatabaseAuthenticationEnabled
DBClusterAutomatedBackup.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled) Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- Parameters:
iamDatabaseAuthenticationEnabled
- Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterCreateTime
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
- Parameters:
clusterCreateTime
- The time when the DB cluster was created, in Universal Coordinated Time (UTC).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageEncrypted
Indicates whether the source DB cluster is encrypted.
- Parameters:
storageEncrypted
- Indicates whether the source DB cluster is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allocatedStorage
For all database engines except Amazon Aurora,
AllocatedStorage
specifies the allocated storage size in gibibytes (GiB). For Aurora,AllocatedStorage
always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.- Parameters:
allocatedStorage
- For all database engines except Amazon Aurora,AllocatedStorage
specifies the allocated storage size in gibibytes (GiB). For Aurora,AllocatedStorage
always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
The version of the database engine for the automated backup.
- Parameters:
engineVersion
- The version of the database engine for the automated backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterArn
The Amazon Resource Name (ARN) for the source DB cluster.
- Parameters:
dbClusterArn
- The Amazon Resource Name (ARN) for the source DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backupRetentionPeriod
The retention period for the automated backups.
- Parameters:
backupRetentionPeriod
- The retention period for the automated backups.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineMode
The engine mode of the database engine for the automated backup.
- Parameters:
engineMode
- The engine mode of the database engine for the automated backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZones
The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
- Parameters:
availabilityZones
- The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZones
The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
- Parameters:
availabilityZones
- The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values:
1150-65535
- Parameters:
port
- The port number that the automated backup used for connections.Default: Inherits from the source DB cluster
Valid Values:
1150-65535
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Parameters:
kmsKeyId
- The Amazon Web Services KMS key ID for an automated backup.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageType
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Parameters:
storageType
- The storage type associated with the DB cluster.This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iops
The IOPS (I/O operations per second) value for the automated backup.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Parameters:
iops
- The IOPS (I/O operations per second) value for the automated backup.This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- Parameters:
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageThroughput
The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Parameters:
storageThroughput
- The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-