Package software.amazon.awssdk.services.rds.model

Interface RestoreDBClusterFromSnapshotRequest.Builder

All Superinterfaces:

CopyableBuilder<RestoreDBClusterFromSnapshotRequest.Builder,RestoreDBClusterFromSnapshotRequest>, SdkBuilder<RestoreDBClusterFromSnapshotRequest.Builder,RestoreDBClusterFromSnapshotRequest>

Enclosing class:

RestoreDBClusterFromSnapshotRequest

public static interface RestoreDBClusterFromSnapshotRequest.Builder
extends CopyableBuilder<RestoreDBClusterFromSnapshotRequest.Builder,RestoreDBClusterFromSnapshotRequest>

Method Summary

Modifier and Type	Method	Description
RestoreDBClusterFromSnapshotRequest.Builder	availabilityZones(String... availabilityZones)	Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
RestoreDBClusterFromSnapshotRequest.Builder	availabilityZones(Collection<String> availabilityZones)	Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
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 cluster snapshot.
RestoreDBClusterFromSnapshotRequest.Builder	dbSubnetGroupName(String dbSubnetGroupName)	The name of the DB subnet group to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest.Builder	enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)	A Boolean value that is 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	engineVersion(String engineVersion)	The version of the database engine to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest.Builder	kmsKeyId(String kmsKeyId)	The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot.
RestoreDBClusterFromSnapshotRequest.Builder	optionGroupName(String optionGroupName)	The name of the option group to use for the restored DB cluster.
RestoreDBClusterFromSnapshotRequest.Builder	port(Integer port)	The port number on which the new DB cluster accepts connections.
RestoreDBClusterFromSnapshotRequest.Builder	snapshotIdentifier(String snapshotIdentifier)	The identifier for the 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(Tag... tags)	The tags to be assigned to the restored DB cluster.
RestoreDBClusterFromSnapshotRequest.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds)	A list of VPC security groups that the new DB cluster will belong to.
RestoreDBClusterFromSnapshotRequest.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)	A list of VPC security groups that the new DB cluster will belong to.

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

copy

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

apply, build

Method Detail

availabilityZones

RestoreDBClusterFromSnapshotRequest.Builder availabilityZones(Collection<String> availabilityZones)

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

Parameters:

availabilityZones - Provides the list of 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 EC2 Availability Zones that instances in the restored DB cluster can be created in.

NOTE: This method appends the values to the existing list (if any). Use #setAvailabilityZones(java.util.Collection) or #withAvailabilityZones(java.util.Collection) if you want to override the existing values.

Parameters:

availabilityZones - Provides the list of 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 cluster snapshot. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot 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 cluster snapshot. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot 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 cluster snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

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: 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: 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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Parameters:

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

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

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.

NOTE: This method appends the values to the existing list (if any). Use #setVpcSecurityGroupIds(java.util.Collection) or #withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.

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.

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

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.

kmsKeyId

RestoreDBClusterFromSnapshotRequest.Builder kmsKeyId(String kmsKeyId)

The KMS key identifier to use when restoring an encrypted DB cluster from a 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 do not specify a value for the KmsKeyId parameter, then the following will occur:

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

• If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.

Parameters:

kmsKeyId - The KMS key identifier to use when restoring an encrypted DB cluster from a 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 do not specify a value for the KmsKeyId parameter, then the following will occur:

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

• If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.

Returns:

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

enableIAMDatabaseAuthentication

RestoreDBClusterFromSnapshotRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - A Boolean value that is 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.