com.amazonaws.services.rds.model

Class RestoreDBClusterFromSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.RestoreDBClusterFromSnapshotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RestoreDBClusterFromSnapshotRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RestoreDBClusterFromSnapshotRequest()

Method Summary

Modifier and Type	Method and Description
RestoreDBClusterFromSnapshotRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAvailabilityZones() Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
String	getDatabaseName() The database name for the restored DB cluster.
String	getDBClusterIdentifier() The name of the DB cluster to create from the DB cluster snapshot.
String	getDBSubnetGroupName() The name of the DB subnet group to use for the new DB cluster.
String	getEngine() The database engine to use for the new DB cluster.
String	getEngineVersion() The version of the database engine to use for the new DB cluster.
String	getKmsKeyId() The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot.
String	getOptionGroupName() The name of the option group to use for the restored DB cluster.
Integer	getPort() The port number on which the new DB cluster accepts connections.
String	getSnapshotIdentifier() The identifier for the DB cluster snapshot to restore from.
List<Tag>	getTags() The tags to be assigned to the restored DB cluster.
List<String>	getVpcSecurityGroupIds() A list of VPC security groups that the new DB cluster will belong to.
int	hashCode()
void	setAvailabilityZones(Collection<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
void	setDatabaseName(String databaseName) The database name for the restored DB cluster.
void	setDBClusterIdentifier(String dBClusterIdentifier) The name of the DB cluster to create from the DB cluster snapshot.
void	setDBSubnetGroupName(String dBSubnetGroupName) The name of the DB subnet group to use for the new DB cluster.
void	setEngine(String engine) The database engine to use for the new DB cluster.
void	setEngineVersion(String engineVersion) The version of the database engine to use for the new DB cluster.
void	setKmsKeyId(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot.
void	setOptionGroupName(String optionGroupName) The name of the option group to use for the restored DB cluster.
void	setPort(Integer port) The port number on which the new DB cluster accepts connections.
void	setSnapshotIdentifier(String snapshotIdentifier) The identifier for the DB cluster snapshot to restore from.
void	setTags(Collection<Tag> tags) The tags to be assigned to the restored DB cluster.
void	setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RestoreDBClusterFromSnapshotRequest	withAvailabilityZones(Collection<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
RestoreDBClusterFromSnapshotRequest	withAvailabilityZones(String... availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
RestoreDBClusterFromSnapshotRequest	withDatabaseName(String databaseName) The database name for the restored DB cluster.
RestoreDBClusterFromSnapshotRequest	withDBClusterIdentifier(String dBClusterIdentifier) The name of the DB cluster to create from the DB cluster snapshot.
RestoreDBClusterFromSnapshotRequest	withDBSubnetGroupName(String dBSubnetGroupName) The name of the DB subnet group to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest	withEngine(String engine) The database engine to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest	withEngineVersion(String engineVersion) The version of the database engine to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest	withKmsKeyId(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot.
RestoreDBClusterFromSnapshotRequest	withOptionGroupName(String optionGroupName) The name of the option group to use for the restored DB cluster.
RestoreDBClusterFromSnapshotRequest	withPort(Integer port) The port number on which the new DB cluster accepts connections.
RestoreDBClusterFromSnapshotRequest	withSnapshotIdentifier(String snapshotIdentifier) The identifier for the DB cluster snapshot to restore from.
RestoreDBClusterFromSnapshotRequest	withTags(Collection<Tag> tags) The tags to be assigned to the restored DB cluster.
RestoreDBClusterFromSnapshotRequest	withTags(Tag... tags) The tags to be assigned to the restored DB cluster.
RestoreDBClusterFromSnapshotRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.
RestoreDBClusterFromSnapshotRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreDBClusterFromSnapshotRequest

public RestoreDBClusterFromSnapshotRequest()

Method Detail

getAvailabilityZones

public List<String> getAvailabilityZones()

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.

setAvailabilityZones

public void setAvailabilityZones(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.

withAvailabilityZones

public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(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.

withAvailabilityZones

public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(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.

setDBClusterIdentifier

public void setDBClusterIdentifier(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

getDBClusterIdentifier

public String getDBClusterIdentifier()

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

withDBClusterIdentifier

public RestoreDBClusterFromSnapshotRequest withDBClusterIdentifier(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.

setSnapshotIdentifier

public void setSnapshotIdentifier(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

getSnapshotIdentifier

public String getSnapshotIdentifier()

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

withSnapshotIdentifier

public RestoreDBClusterFromSnapshotRequest withSnapshotIdentifier(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.

setEngine

public void setEngine(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

getEngine

public String getEngine()

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

withEngine

public RestoreDBClusterFromSnapshotRequest withEngine(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.

setEngineVersion

public void setEngineVersion(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.

getEngineVersion

public String getEngineVersion()

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.

withEngineVersion

public RestoreDBClusterFromSnapshotRequest withEngineVersion(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.

setPort

public void setPort(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.

getPort

public Integer getPort()

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.

withPort

public RestoreDBClusterFromSnapshotRequest withPort(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.

setDBSubnetGroupName

public void setDBSubnetGroupName(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

getDBSubnetGroupName

public String getDBSubnetGroupName()

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

withDBSubnetGroupName

public RestoreDBClusterFromSnapshotRequest withDBSubnetGroupName(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.

setDatabaseName

public void setDatabaseName(String databaseName)

The database name for the restored DB cluster.

Parameters:

databaseName - The database name for the restored DB cluster.

getDatabaseName

public String getDatabaseName()

The database name for the restored DB cluster.

Returns:

The database name for the restored DB cluster.

withDatabaseName

public RestoreDBClusterFromSnapshotRequest withDatabaseName(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.

setOptionGroupName

public void setOptionGroupName(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.

getOptionGroupName

public String getOptionGroupName()

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.

withOptionGroupName

public RestoreDBClusterFromSnapshotRequest withOptionGroupName(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.

getVpcSecurityGroupIds

public List<String> getVpcSecurityGroupIds()

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.

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(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.

withVpcSecurityGroupIds

public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(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.

withVpcSecurityGroupIds

public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(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.

getTags

public List<Tag> getTags()

The tags to be assigned to the restored DB cluster.

Returns:

The tags to be assigned to the restored DB cluster.

setTags

public void setTags(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.

withTags

public RestoreDBClusterFromSnapshotRequest withTags(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.

withTags

public RestoreDBClusterFromSnapshotRequest withTags(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.

setKmsKeyId

public void setKmsKeyId(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.

getKmsKeyId

public String getKmsKeyId()

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.

withKmsKeyId

public RestoreDBClusterFromSnapshotRequest withKmsKeyId(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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RestoreDBClusterFromSnapshotRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()