software.amazon.awssdk.services.rds.model

Interface RestoreDbClusterFromSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>, RdsRequest.Builder, SdkBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RestoreDbClusterFromSnapshotRequest

public static interface RestoreDbClusterFromSnapshotRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>

Method Summary

Modifier and Type	Method and Description
RestoreDbClusterFromSnapshotRequest.Builder	availabilityZones(Collection<String> availabilityZones) Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
RestoreDbClusterFromSnapshotRequest.Builder	availabilityZones(String... availabilityZones) Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
RestoreDbClusterFromSnapshotRequest.Builder	backtrackWindow(Long backtrackWindow) The target backtrack window, in seconds.
RestoreDbClusterFromSnapshotRequest.Builder	databaseName(String databaseName) The database name for the restored DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier) The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
RestoreDbClusterFromSnapshotRequest.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName) The name of the DB cluster parameter group to associate with this DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	dbSubnetGroupName(String dbSubnetGroupName) The name of the DB subnet group to use for the new DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	deletionProtection(Boolean deletionProtection) Indicates if the DB cluster should have deletion protection enabled.
RestoreDbClusterFromSnapshotRequest.Builder	enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports) The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
RestoreDbClusterFromSnapshotRequest.Builder	enableCloudwatchLogsExports(String... enableCloudwatchLogsExports) The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
RestoreDbClusterFromSnapshotRequest.Builder	enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
RestoreDbClusterFromSnapshotRequest.Builder	engine(String engine) The database engine to use for the new DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	engineMode(String engineMode) The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
RestoreDbClusterFromSnapshotRequest.Builder	engineVersion(String engineVersion) The version of the database engine to use for the new DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	kmsKeyId(String kmsKeyId) The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
RestoreDbClusterFromSnapshotRequest.Builder	optionGroupName(String optionGroupName) The name of the option group to use for the restored DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
RestoreDbClusterFromSnapshotRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
RestoreDbClusterFromSnapshotRequest.Builder	port(Integer port) The port number on which the new DB cluster accepts connections.
default RestoreDbClusterFromSnapshotRequest.Builder	scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration) For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	scalingConfiguration(ScalingConfiguration scalingConfiguration) For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	snapshotIdentifier(String snapshotIdentifier) The identifier for the DB snapshot or DB cluster snapshot to restore from.
RestoreDbClusterFromSnapshotRequest.Builder	tags(Collection<Tag> tags) The tags to be assigned to the restored DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tags to be assigned to the restored DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	tags(Tag... tags) The tags to be assigned to the restored DB cluster.
RestoreDbClusterFromSnapshotRequest.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.
RestoreDbClusterFromSnapshotRequest.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

availabilityZones

RestoreDbClusterFromSnapshotRequest.Builder availabilityZones(Collection<String> availabilityZones)

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Parameters:

availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

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

availabilityZones

RestoreDbClusterFromSnapshotRequest.Builder availabilityZones(String... availabilityZones)

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Parameters:

availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

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

dbClusterIdentifier

RestoreDbClusterFromSnapshotRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Parameters:

dbClusterIdentifier - The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Returns:

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

snapshotIdentifier

RestoreDbClusterFromSnapshotRequest.Builder snapshotIdentifier(String snapshotIdentifier)

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

Parameters:

snapshotIdentifier - The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

Returns:

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

engine

RestoreDbClusterFromSnapshotRequest.Builder engine(String engine)

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Parameters:

engine - The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Returns:

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

engineVersion

RestoreDbClusterFromSnapshotRequest.Builder engineVersion(String engineVersion)

The version of the database engine to use for the new DB cluster.

Parameters:

engineVersion - The version of the database engine to use for the new DB cluster.

Returns:

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

port

RestoreDbClusterFromSnapshotRequest.Builder port(Integer port)

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Parameters:

port - The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Returns:

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

dbSubnetGroupName

RestoreDbClusterFromSnapshotRequest.Builder dbSubnetGroupName(String dbSubnetGroupName)

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Parameters:

dbSubnetGroupName - The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Returns:

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

databaseName

RestoreDbClusterFromSnapshotRequest.Builder databaseName(String databaseName)

The database name for the restored DB cluster.

Parameters:

databaseName - The database name for the restored DB cluster.

Returns:

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

optionGroupName

RestoreDbClusterFromSnapshotRequest.Builder optionGroupName(String optionGroupName)

The name of the option group to use for the restored DB cluster.

Parameters:

optionGroupName - The name of the option group to use for the restored DB cluster.

Returns:

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

vpcSecurityGroupIds

RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A list of VPC security groups that the new DB cluster will belong to.

Parameters:

vpcSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.

Returns:

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

vpcSecurityGroupIds

RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

A list of VPC security groups that the new DB cluster will belong to.

Parameters:

vpcSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.

Returns:

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

tags

RestoreDbClusterFromSnapshotRequest.Builder tags(Collection<Tag> tags)

The tags to be assigned to the restored DB cluster.

Parameters:

tags - The tags to be assigned to the restored DB cluster.

Returns:

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

tags

RestoreDbClusterFromSnapshotRequest.Builder tags(Tag... tags)

The tags to be assigned to the restored DB cluster.

Parameters:

tags - The tags to be assigned to the restored DB cluster.

Returns:

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

tags

RestoreDbClusterFromSnapshotRequest.Builder tags(Consumer<Tag.Builder>... tags)

The tags to be assigned to the restored DB cluster.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

kmsKeyId

RestoreDbClusterFromSnapshotRequest.Builder kmsKeyId(String kmsKeyId)

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Parameters:

kmsKeyId - The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Returns:

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

enableIAMDatabaseAuthentication

RestoreDbClusterFromSnapshotRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

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

backtrackWindow

RestoreDbClusterFromSnapshotRequest.Builder backtrackWindow(Long backtrackWindow)

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Parameters:

backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Returns:

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

enableCloudwatchLogsExports

RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Parameters:

enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Returns:

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

enableCloudwatchLogsExports

RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Parameters:

enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Returns:

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

engineMode

RestoreDbClusterFromSnapshotRequest.Builder engineMode(String engineMode)

The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.

Parameters:

engineMode - The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.

Returns:

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

scalingConfiguration

RestoreDbClusterFromSnapshotRequest.Builder scalingConfiguration(ScalingConfiguration scalingConfiguration)

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Parameters:

scalingConfiguration - For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Returns:

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

scalingConfiguration

default RestoreDbClusterFromSnapshotRequest.Builder scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

This is a convenience that creates an instance of the ScalingConfiguration.Builder avoiding the need to create one manually via ScalingConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfiguration(ScalingConfiguration).

Parameters:

scalingConfiguration - a consumer that will call methods on ScalingConfiguration.Builder

Returns:

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

See Also:

scalingConfiguration(ScalingConfiguration)

dbClusterParameterGroupName

RestoreDbClusterFromSnapshotRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

• If supplied, must match the name of an existing default DB cluster parameter group.

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

Parameters:

dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

• If supplied, must match the name of an existing default DB cluster parameter group.

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

Returns:

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

deletionProtection

RestoreDbClusterFromSnapshotRequest.Builder deletionProtection(Boolean deletionProtection)

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

Parameters:

deletionProtection - Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

Returns:

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

overrideConfiguration

RestoreDbClusterFromSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

RestoreDbClusterFromSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.