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

Class RestoreDBClusterFromSnapshotRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.RestoreDBClusterFromSnapshotRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<RestoreDBClusterFromSnapshotRequest.Builder,RestoreDBClusterFromSnapshotRequest>

@Generated("software.amazon.awssdk:codegen")
public class RestoreDBClusterFromSnapshotRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<RestoreDBClusterFromSnapshotRequest.Builder,RestoreDBClusterFromSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestoreDBClusterFromSnapshotRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
List<String>	availabilityZones()	Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
static RestoreDBClusterFromSnapshotRequest.Builder	builder()
String	databaseName()	The database name for the restored DB cluster.
String	dbClusterIdentifier()	The name of the DB cluster to create from the DB cluster snapshot.
String	dbSubnetGroupName()	The name of the DB subnet group to use for the new DB cluster.
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.
String	engine()	The database engine to use for the new DB cluster.
String	engineVersion()	The version of the database engine to use for the new DB cluster.
boolean	equals(Object obj)
int	hashCode()
String	kmsKeyId()	The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot.
String	optionGroupName()	The name of the option group to use for the restored DB cluster.
Integer	port()	The port number on which the new DB cluster accepts connections.
static Class<? extends RestoreDBClusterFromSnapshotRequest.Builder>	serializableBuilderClass()
String	snapshotIdentifier()	The identifier for the DB cluster snapshot to restore from.
List<Tag>	tags()	The tags to be assigned to the restored DB cluster.
RestoreDBClusterFromSnapshotRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<String>	vpcSecurityGroupIds()	A list of VPC security groups that the new DB cluster will belong to.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

availabilityZones

public List<String> availabilityZones()

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

Returns:

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

dbClusterIdentifier

public 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

Returns:

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

snapshotIdentifier

public 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

Returns:

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

engine

public 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

Returns:

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

engineVersion

public String engineVersion()

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

Returns:

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

port

public 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.

Returns:

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.

dbSubnetGroupName

public 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

Returns:

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

databaseName

public String databaseName()

The database name for the restored DB cluster.

Returns:

The database name for the restored DB cluster.

optionGroupName

public String optionGroupName()

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

Returns:

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

vpcSecurityGroupIds

public List<String> vpcSecurityGroupIds()

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

Returns:

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

tags

public List<Tag> tags()

The tags to be assigned to the restored DB cluster.

Returns:

The tags to be assigned to the restored DB cluster.

kmsKeyId

public 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.

Returns:

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.

enableIAMDatabaseAuthentication

public 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

Returns:

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

toBuilder

public RestoreDBClusterFromSnapshotRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RestoreDBClusterFromSnapshotRequest.Builder,RestoreDBClusterFromSnapshotRequest>

Returns:

a builder for type T

builder

public static RestoreDBClusterFromSnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RestoreDBClusterFromSnapshotRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object