com.amazonaws.services.rds.model

Class RestoreDBClusterFromSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.RestoreDBClusterFromSnapshotRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RestoreDBClusterFromSnapshotRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RestoreDBClusterFromSnapshot operation.

Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

See Also:

AmazonRDS.restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RestoreDBClusterFromSnapshotRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RestoreDBClusterFromSnapshotRequest	clone() Creates a shallow clone of this request.
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	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	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	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

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, 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.

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

Parameters:

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

Returns:

A reference to this updated 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.

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

withEngineVersion

public RestoreDBClusterFromSnapshotRequest withEngineVersion(String engineVersion)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

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

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:

A reference to this updated object so that method calls can be chained together.

getDBSubnetGroupName

public String getDBSubnetGroupName()

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

Returns:

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

setDBSubnetGroupName

public void setDBSubnetGroupName(String dBSubnetGroupName)

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

Parameters:

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

withDBSubnetGroupName

public RestoreDBClusterFromSnapshotRequest withDBSubnetGroupName(String dBSubnetGroupName)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDatabaseName

public String getDatabaseName()

The database name for the restored DB cluster.

Returns:

The database name for the restored DB cluster.

setDatabaseName

public void setDatabaseName(String databaseName)

The database name for the restored DB cluster.

Parameters:

databaseName - The database name for the restored DB cluster.

withDatabaseName

public RestoreDBClusterFromSnapshotRequest withDatabaseName(String databaseName)

The database name for the restored DB cluster.

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

Parameters:

databaseName - The database name for the restored DB cluster.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withOptionGroupName

public RestoreDBClusterFromSnapshotRequest withOptionGroupName(String optionGroupName)

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

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

Parameters:

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

Returns:

A reference to this updated 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.

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

Parameters:

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

Returns:

A reference to this updated 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.

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

Parameters:

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

Returns:

A reference to this updated 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.

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

Parameters:

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

Returns:

A reference to this updated 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.

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

Parameters:

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

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RestoreDBClusterFromSnapshotRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()