public class RestoreDBClusterToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreDBClusterToPointInTimeRequest() |
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() |
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) |
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) |
RestoreDBClusterToPointInTimeRequest |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
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.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public RestoreDBClusterToPointInTimeRequest()
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
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.
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.
public void setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name 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
dBSubnetGroupName
- The DB subnet group name 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
public String getDBSubnetGroupName()
The DB subnet group name 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
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
public RestoreDBClusterToPointInTimeRequest withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name 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
dBSubnetGroupName
- The DB subnet group name 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
public void setOptionGroupName(String optionGroupName)
The name of the option group for the new DB cluster.
optionGroupName
- The name of the option group for the new DB cluster.public String getOptionGroupName()
The name of the option group for the new DB cluster.
public RestoreDBClusterToPointInTimeRequest withOptionGroupName(String optionGroupName)
The name of the option group for the new DB cluster.
optionGroupName
- The name of the option group for the new DB cluster.public List<String> getVpcSecurityGroupIds()
A lst of VPC security groups that the new DB cluster belongs to.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A lst of VPC security groups that the new DB cluster belongs to.
vpcSecurityGroupIds
- A lst of VPC security groups that the new DB cluster belongs to.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.
vpcSecurityGroupIds
- A lst of VPC security groups that the new DB cluster belongs to.public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A lst of VPC security groups that the new DB cluster belongs to.
vpcSecurityGroupIds
- A lst of VPC security groups that the new DB cluster belongs to.public void setTags(Collection<Tag> tags)
tags
- public RestoreDBClusterToPointInTimeRequest withTags(Tag... 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.
tags
- public RestoreDBClusterToPointInTimeRequest withTags(Collection<Tag> tags)
tags
- 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.
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.
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.
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.
public RestoreDBClusterToPointInTimeRequest withKmsKeyId(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.
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.
public String toString()
toString
in class Object
Object.toString()
public RestoreDBClusterToPointInTimeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.