software.amazon.awssdk.services.rds.model

Interface DBClusterAutomatedBackup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DBClusterAutomatedBackup.Builder,DBClusterAutomatedBackup>, SdkBuilder<DBClusterAutomatedBackup.Builder,DBClusterAutomatedBackup>, SdkPojo

Enclosing class:

DBClusterAutomatedBackup

public static interface DBClusterAutomatedBackup.Builder
extends SdkPojo, CopyableBuilder<DBClusterAutomatedBackup.Builder,DBClusterAutomatedBackup>

Method Summary

Modifier and Type	Method and Description
DBClusterAutomatedBackup.Builder	allocatedStorage(Integer allocatedStorage) For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB).
DBClusterAutomatedBackup.Builder	availabilityZones(Collection<String> availabilityZones) The Availability Zones where instances in the DB cluster can be created.
DBClusterAutomatedBackup.Builder	availabilityZones(String... availabilityZones) The Availability Zones where instances in the DB cluster can be created.
DBClusterAutomatedBackup.Builder	awsBackupRecoveryPointArn(String awsBackupRecoveryPointArn) The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
DBClusterAutomatedBackup.Builder	backupRetentionPeriod(Integer backupRetentionPeriod) The retention period for the automated backups.
DBClusterAutomatedBackup.Builder	clusterCreateTime(Instant clusterCreateTime) The time when the DB cluster was created, in Universal Coordinated Time (UTC).
DBClusterAutomatedBackup.Builder	dbClusterArn(String dbClusterArn) The Amazon Resource Name (ARN) for the source DB cluster.
DBClusterAutomatedBackup.Builder	dbClusterAutomatedBackupsArn(String dbClusterAutomatedBackupsArn) The Amazon Resource Name (ARN) for the automated backups.
DBClusterAutomatedBackup.Builder	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.
DBClusterAutomatedBackup.Builder	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.
DBClusterAutomatedBackup.Builder	engine(String engine) The name of the database engine for this automated backup.
DBClusterAutomatedBackup.Builder	engineMode(String engineMode) The engine mode of the database engine for the automated backup.
DBClusterAutomatedBackup.Builder	engineVersion(String engineVersion) The version of the database engine for the automated backup.
DBClusterAutomatedBackup.Builder	iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled) Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
DBClusterAutomatedBackup.Builder	iops(Integer iops) The IOPS (I/O operations per second) value for the automated backup.
DBClusterAutomatedBackup.Builder	kmsKeyId(String kmsKeyId) The Amazon Web Services KMS key ID for an automated backup.
DBClusterAutomatedBackup.Builder	licenseModel(String licenseModel) The license model information for this DB cluster automated backup.
DBClusterAutomatedBackup.Builder	masterUsername(String masterUsername) The master user name of the automated backup.
DBClusterAutomatedBackup.Builder	port(Integer port) The port number that the automated backup used for connections.
DBClusterAutomatedBackup.Builder	region(String region) 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.
DBClusterAutomatedBackup.Builder	restoreWindow(RestoreWindow restoreWindow) Sets the value of the RestoreWindow property for this object.
DBClusterAutomatedBackup.Builder	status(String status) A list of status information for an automated backup:
DBClusterAutomatedBackup.Builder	storageEncrypted(Boolean storageEncrypted) Indicates whether the source DB cluster is encrypted.
DBClusterAutomatedBackup.Builder	storageType(String storageType) The storage type associated with the DB cluster.
DBClusterAutomatedBackup.Builder	vpcId(String vpcId) The VPC ID associated with the DB cluster.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

engine

DBClusterAutomatedBackup.Builder engine(String 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

DBClusterAutomatedBackup.Builder vpcId(String 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

DBClusterAutomatedBackup.Builder dbClusterAutomatedBackupsArn(String 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

DBClusterAutomatedBackup.Builder 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.

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

DBClusterAutomatedBackup.Builder restoreWindow(RestoreWindow 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 the RestoreWindow.Builder avoiding the need to create one manually via RestoreWindow.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to restoreWindow(RestoreWindow).

Parameters:

restoreWindow - a consumer that will call methods on RestoreWindow.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

restoreWindow(RestoreWindow)

masterUsername

DBClusterAutomatedBackup.Builder masterUsername(String 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

DBClusterAutomatedBackup.Builder 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.

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

DBClusterAutomatedBackup.Builder region(String 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

DBClusterAutomatedBackup.Builder licenseModel(String 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

DBClusterAutomatedBackup.Builder status(String 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

DBClusterAutomatedBackup.Builder clusterCreateTime(Instant 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

DBClusterAutomatedBackup.Builder storageEncrypted(Boolean 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

DBClusterAutomatedBackup.Builder allocatedStorage(Integer 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

DBClusterAutomatedBackup.Builder engineVersion(String 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

DBClusterAutomatedBackup.Builder dbClusterArn(String 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

DBClusterAutomatedBackup.Builder backupRetentionPeriod(Integer 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

DBClusterAutomatedBackup.Builder engineMode(String 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

DBClusterAutomatedBackup.Builder availabilityZones(Collection<String> 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

DBClusterAutomatedBackup.Builder availabilityZones(String... 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

DBClusterAutomatedBackup.Builder port(Integer 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

DBClusterAutomatedBackup.Builder kmsKeyId(String 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

DBClusterAutomatedBackup.Builder storageType(String 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

DBClusterAutomatedBackup.Builder iops(Integer 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

DBClusterAutomatedBackup.Builder awsBackupRecoveryPointArn(String 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.