com.amazonaws.services.rds.model

Class RestoreDBClusterToPointInTimeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.RestoreDBClusterToPointInTimeRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RestoreDBClusterToPointInTimeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RestoreDBClusterToPointInTime operation.

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

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

See Also:

AmazonRDS.restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RestoreDBClusterToPointInTimeRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RestoreDBClusterToPointInTimeRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBClusterIdentifier() The name of the new DB cluster to be created.
String	getDBSubnetGroupName() The DB subnet group name to use for the new DB cluster.
String	getKmsKeyId() The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
String	getOptionGroupName() The name of the option group for the new DB cluster.
Integer	getPort() The port number on which the new DB cluster accepts connections.
Date	getRestoreToTime() The date and time to restore the DB cluster to.
String	getSourceDBClusterIdentifier() The identifier of the source DB cluster from which to restore.
List<Tag>	getTags() A list of tags.
Boolean	getUseLatestRestorableTime() A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
List<String>	getVpcSecurityGroupIds() A lst of VPC security groups that the new DB cluster belongs to.
int	hashCode()
Boolean	isUseLatestRestorableTime() A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
void	setDBClusterIdentifier(String dBClusterIdentifier) The name of the new DB cluster to be created.
void	setDBSubnetGroupName(String dBSubnetGroupName) The DB subnet group name to use for the new DB cluster.
void	setKmsKeyId(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
void	setOptionGroupName(String optionGroupName) The name of the option group for the new DB cluster.
void	setPort(Integer port) The port number on which the new DB cluster accepts connections.
void	setRestoreToTime(Date restoreToTime) The date and time to restore the DB cluster to.
void	setSourceDBClusterIdentifier(String sourceDBClusterIdentifier) The identifier of the source DB cluster from which to restore.
void	setTags(Collection<Tag> tags) A list of tags.
void	setUseLatestRestorableTime(Boolean useLatestRestorableTime) A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
void	setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A lst of VPC security groups that the new DB cluster belongs to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RestoreDBClusterToPointInTimeRequest	withDBClusterIdentifier(String dBClusterIdentifier) The name of the new DB cluster to be created.
RestoreDBClusterToPointInTimeRequest	withDBSubnetGroupName(String dBSubnetGroupName) The DB subnet group name to use for the new DB cluster.
RestoreDBClusterToPointInTimeRequest	withKmsKeyId(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
RestoreDBClusterToPointInTimeRequest	withOptionGroupName(String optionGroupName) The name of the option group for the new DB cluster.
RestoreDBClusterToPointInTimeRequest	withPort(Integer port) The port number on which the new DB cluster accepts connections.
RestoreDBClusterToPointInTimeRequest	withRestoreToTime(Date restoreToTime) The date and time to restore the DB cluster to.
RestoreDBClusterToPointInTimeRequest	withSourceDBClusterIdentifier(String sourceDBClusterIdentifier) The identifier of the source DB cluster from which to restore.
RestoreDBClusterToPointInTimeRequest	withTags(Collection<Tag> tags) A list of tags.
RestoreDBClusterToPointInTimeRequest	withTags(Tag... tags) A list of tags.
RestoreDBClusterToPointInTimeRequest	withUseLatestRestorableTime(Boolean useLatestRestorableTime) A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
RestoreDBClusterToPointInTimeRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A lst of VPC security groups that the new DB cluster belongs to.
RestoreDBClusterToPointInTimeRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A lst of VPC security groups that the new DB cluster belongs to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreDBClusterToPointInTimeRequest

public RestoreDBClusterToPointInTimeRequest()

Method Detail

getDBClusterIdentifier

public String getDBClusterIdentifier()

The name of the new DB cluster to be created.

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 name of the new DB cluster to be created.

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

setDBClusterIdentifier

public void setDBClusterIdentifier(String dBClusterIdentifier)

The name of the new DB cluster to be created.

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:

dBClusterIdentifier - The name of the new DB cluster to be created.

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

withDBClusterIdentifier

public RestoreDBClusterToPointInTimeRequest withDBClusterIdentifier(String dBClusterIdentifier)

The name of the new DB cluster to be created.

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:

dBClusterIdentifier - The name of the new DB cluster to be created.

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.

getSourceDBClusterIdentifier

public String getSourceDBClusterIdentifier()

The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• 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 of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• 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

setSourceDBClusterIdentifier

public void setSourceDBClusterIdentifier(String sourceDBClusterIdentifier)

The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• 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:

sourceDBClusterIdentifier - The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• 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

withSourceDBClusterIdentifier

public RestoreDBClusterToPointInTimeRequest withSourceDBClusterIdentifier(String sourceDBClusterIdentifier)

The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• 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:

sourceDBClusterIdentifier - The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• 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.

getRestoreToTime

public Date getRestoreToTime()

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2015-03-07T23:45:00Z

Returns:

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2015-03-07T23:45:00Z

setRestoreToTime

public void setRestoreToTime(Date restoreToTime)

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2015-03-07T23:45:00Z

Parameters:

restoreToTime - The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2015-03-07T23:45:00Z

withRestoreToTime

public RestoreDBClusterToPointInTimeRequest withRestoreToTime(Date restoreToTime)

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2015-03-07T23:45:00Z

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

Parameters:

restoreToTime - The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2015-03-07T23:45:00Z

Returns:

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

isUseLatestRestorableTime

public Boolean isUseLatestRestorableTime()

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

Returns:

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

setUseLatestRestorableTime

public void setUseLatestRestorableTime(Boolean useLatestRestorableTime)

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

Parameters:

useLatestRestorableTime - A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

withUseLatestRestorableTime

public RestoreDBClusterToPointInTimeRequest withUseLatestRestorableTime(Boolean useLatestRestorableTime)

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

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

Parameters:

useLatestRestorableTime - A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

Returns:

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

getUseLatestRestorableTime

public Boolean getUseLatestRestorableTime()

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

Returns:

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

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 RestoreDBClusterToPointInTimeRequest 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 DB subnet group name to use for the new DB cluster.

Returns:

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

setDBSubnetGroupName

public void setDBSubnetGroupName(String dBSubnetGroupName)

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

Parameters:

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

withDBSubnetGroupName

public RestoreDBClusterToPointInTimeRequest withDBSubnetGroupName(String dBSubnetGroupName)

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

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

Parameters:

dBSubnetGroupName - The DB subnet group name to use for the new 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 for the new DB cluster.

Returns:

The name of the option group for the new DB cluster.

setOptionGroupName

public void setOptionGroupName(String optionGroupName)

The name of the option group for the new DB cluster.

Parameters:

optionGroupName - The name of the option group for the new DB cluster.

withOptionGroupName

public RestoreDBClusterToPointInTimeRequest withOptionGroupName(String optionGroupName)

The name of the option group for the new DB cluster.

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

Parameters:

optionGroupName - The name of the option group for the new DB cluster.

Returns:

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

getVpcSecurityGroupIds

public List<String> getVpcSecurityGroupIds()

A lst of VPC security groups that the new DB cluster belongs to.

Returns:

A lst of VPC security groups that the new DB cluster belongs to.

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A lst of VPC security groups that the new DB cluster belongs to.

Parameters:

vpcSecurityGroupIds - A lst of VPC security groups that the new DB cluster belongs to.

withVpcSecurityGroupIds

public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

A lst of VPC security groups that the new DB cluster belongs 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 lst of VPC security groups that the new DB cluster belongs to.

Returns:

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

withVpcSecurityGroupIds

public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A lst of VPC security groups that the new DB cluster belongs to.

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

Parameters:

vpcSecurityGroupIds - A lst of VPC security groups that the new DB cluster belongs to.

Returns:

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

getTags

public List<Tag> getTags()

A list of tags.

Returns:

A list of tags.

setTags

public void setTags(Collection<Tag> tags)

A list of tags.

Parameters:

tags - A list of tags.

withTags

public RestoreDBClusterToPointInTimeRequest withTags(Tag... tags)

A list of tags.

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 - A list of tags.

Returns:

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

withTags

public RestoreDBClusterToPointInTimeRequest withTags(Collection<Tag> tags)

A list of tags.

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

Parameters:

tags - A list of tags.

Returns:

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

getKmsKeyId

public String getKmsKeyId()

The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

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.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

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

If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.

Returns:

The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

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.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

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

If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

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.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

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

If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.