Class RestoreDBClusterToPointInTimeRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of the new DB cluster to be created.The DB subnet group name to use for the new DB cluster.The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.The name of the option group for the new DB cluster.getPort()
The port number on which the new DB cluster accepts connections.The date and time to restore the DB cluster to.The identifier of the source DB cluster from which to restore.getTags()
A value that is set totrue
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise.A lst of VPC security groups that the new DB cluster belongs to.int
hashCode()
A value that is set totrue
to restore the DB cluster to the latest restorable backup time, andfalse
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
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 totrue
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise.void
setVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A lst of VPC security groups that the new DB cluster belongs to.toString()
Returns a string representation of this object; useful for testing and debugging.withDBClusterIdentifier
(String dBClusterIdentifier) The name of the new DB cluster to be created.withDBSubnetGroupName
(String dBSubnetGroupName) The DB subnet group name to use for the new DB cluster.withKmsKeyId
(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.withOptionGroupName
(String optionGroupName) The name of the option group for the new DB cluster.The port number on which the new DB cluster accepts connections.withRestoreToTime
(Date restoreToTime) The date and time to restore the DB cluster to.withSourceDBClusterIdentifier
(String sourceDBClusterIdentifier) The identifier of the source DB cluster from which to restore.NOTE: This method appends the values to the existing list (if any).withTags
(Collection<Tag> tags) withUseLatestRestorableTime
(Boolean useLatestRestorableTime) A value that is set totrue
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise.withVpcSecurityGroupIds
(String... vpcSecurityGroupIds) A lst of VPC security groups that the new DB cluster belongs to.withVpcSecurityGroupIds
(Collection<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, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
RestoreDBClusterToPointInTimeRequest
public RestoreDBClusterToPointInTimeRequest()
-
-
Method Details
-
setDBClusterIdentifier
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
-
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
-
withDBClusterIdentifier
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceDBClusterIdentifier
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
-
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
-
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
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setRestoreToTime
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
-
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
-
withRestoreToTime
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUseLatestRestorableTime
A value that is set to
true
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if
RestoreToTime
parameter is provided.- Parameters:
useLatestRestorableTime
- A value that is set totrue
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if
RestoreToTime
parameter is provided.
-
getUseLatestRestorableTime
A value that is set to
true
to restore the DB cluster to the latest restorable backup time, andfalse
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, andfalse
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, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if
RestoreToTime
parameter is provided.- Parameters:
useLatestRestorableTime
- A value that is set totrue
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if
RestoreToTime
parameter is provided.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isUseLatestRestorableTime
A value that is set to
true
to restore the DB cluster to the latest restorable backup time, andfalse
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, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if
RestoreToTime
parameter is provided.
-
setPort
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
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
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
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
- Parameters:
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
-
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
- Returns:
- 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
-
withDBSubnetGroupName
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOptionGroupName
The name of the option group for the new DB cluster.
- Parameters:
optionGroupName
- The name of the option group for the new DB cluster.
-
getOptionGroupName
The name of the option group for the new DB cluster.
- Returns:
- The name of the option group for the new DB cluster.
-
withOptionGroupName
The name of the option group for the new DB cluster.
- Parameters:
optionGroupName
- The name of the option group for the new DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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)
orwithVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
vpcSecurityGroupIds
- A lst of VPC security groups that the new DB cluster belongs to.- Returns:
- Returns a reference to this 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.
- Parameters:
vpcSecurityGroupIds
- A lst of VPC security groups that the new DB cluster belongs to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
- Returns:
-
setTags
- Parameters:
tags
-
-
withTags
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKmsKeyId
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.- Parameters:
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.
-
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.
-
withKmsKeyId
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-