@Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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 object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
String |
getDBClusterIdentifier()
The name of the new DB cluster to be created.
|
String |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
getDBSubnetGroupName()
The DB subnet group name to use for the new DB cluster.
|
Boolean |
getDeletionProtection()
Indicates if the DB cluster should have deletion protection enabled.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
String |
getKmsKeyId()
The AWS 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 |
getRestoreType()
The type of restore to be performed.
|
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 list of VPC security groups that the new DB cluster belongs to.
|
int |
hashCode() |
Boolean |
isDeletionProtection()
Indicates if the DB cluster should have deletion protection enabled.
|
Boolean |
isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
Boolean |
isUseLatestRestorableTime()
A value that is set to
true to restore the DB cluster to the latest restorable backup time, and
false otherwise. |
void |
setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The name of the new DB cluster to be created.
|
void |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new DB cluster.
|
void |
setDeletionProtection(Boolean deletionProtection)
Indicates if the DB cluster should have deletion protection enabled.
|
void |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
void |
setKmsKeyId(String kmsKeyId)
The AWS 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 |
setRestoreType(String restoreType)
The type of restore to be performed.
|
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 list 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 |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
RestoreDBClusterToPointInTimeRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The name of the new DB cluster to be created.
|
RestoreDBClusterToPointInTimeRequest |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
RestoreDBClusterToPointInTimeRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new DB cluster.
|
RestoreDBClusterToPointInTimeRequest |
withDeletionProtection(Boolean deletionProtection)
Indicates if the DB cluster should have deletion protection enabled.
|
RestoreDBClusterToPointInTimeRequest |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
RestoreDBClusterToPointInTimeRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
RestoreDBClusterToPointInTimeRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
RestoreDBClusterToPointInTimeRequest |
withKmsKeyId(String kmsKeyId)
The AWS 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 |
withRestoreType(String restoreType)
The type of restore to be performed.
|
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 list of VPC security groups that the new DB cluster belongs to.
|
RestoreDBClusterToPointInTimeRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster belongs to.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, 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 letters, numbers, or hyphens
First character must be a letter
Can't 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 letters, numbers, or hyphens
First character must be a letter
Can't 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 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't 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 letters, numbers, or hyphens
First character must be a letter
Can't 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 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public void setRestoreType(String restoreType)
The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write
if the engine version of the source DB cluster is
earlier than 1.11.
If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy of the
source DB cluster.
restoreType
- The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write
if the engine version of the source DB cluster
is earlier than 1.11.
If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy
of the source DB cluster.
public String getRestoreType()
The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write
if the engine version of the source DB cluster is
earlier than 1.11.
If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy of the
source DB cluster.
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write
if the engine version of the source DB cluster
is earlier than 1.11.
If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy
of the source DB cluster.
public RestoreDBClusterToPointInTimeRequest withRestoreType(String restoreType)
The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write
if the engine version of the source DB cluster is
earlier than 1.11.
If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy of the
source DB cluster.
restoreType
- The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write
if the engine version of the source DB cluster
is earlier than 1.11.
If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy
of the source DB cluster.
public void setSourceDBClusterIdentifier(String sourceDBClusterIdentifier)
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
sourceDBClusterIdentifier
- The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
public String getSourceDBClusterIdentifier()
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Constraints:
Must match the identifier of an existing DBCluster.
public RestoreDBClusterToPointInTimeRequest withSourceDBClusterIdentifier(String sourceDBClusterIdentifier)
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
sourceDBClusterIdentifier
- The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
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
Must be specified if UseLatestRestorableTime
parameter is not provided
Can't be specified if UseLatestRestorableTime
parameter is true
Can't be specified if RestoreType
parameter is copy-on-write
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
Must be specified if UseLatestRestorableTime
parameter is not provided
Can't be specified if UseLatestRestorableTime
parameter is true
Can't be specified if RestoreType
parameter is copy-on-write
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
Must be specified if UseLatestRestorableTime
parameter is not provided
Can't be specified if UseLatestRestorableTime
parameter is true
Can't be specified if RestoreType
parameter is copy-on-write
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
Must be specified if UseLatestRestorableTime
parameter is not provided
Can't be specified if UseLatestRestorableTime
parameter is true
Can't be specified if RestoreType
parameter is copy-on-write
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
Must be specified if UseLatestRestorableTime
parameter is not provided
Can't be specified if UseLatestRestorableTime
parameter is true
Can't be specified if RestoreType
parameter is copy-on-write
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
Must be specified if UseLatestRestorableTime
parameter is not provided
Can't be specified if UseLatestRestorableTime
parameter is true
Can't be specified if RestoreType
parameter is copy-on-write
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: Can't 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: Can't 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: Can't 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: Can't 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: Can't 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: Can't 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: Can't 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: Can't be specified if RestoreToTime
parameter is provided.
public void setPort(Integer port)
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
port
- The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
public Integer getPort()
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
public RestoreDBClusterToPointInTimeRequest withPort(Integer port)
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
port
- The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
public void setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
dBSubnetGroupName
- The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public String getDBSubnetGroupName()
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public RestoreDBClusterToPointInTimeRequest withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
dBSubnetGroupName
- The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
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 list of VPC security groups that the new DB cluster belongs to.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster belongs to.
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster belongs to.public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list 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 list of VPC security groups that the new DB cluster belongs to.public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster belongs to.
vpcSecurityGroupIds
- A list 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 AWS 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 is encrypted with the KMS key identified by the
KmsKeyId
parameter.
If you don't specify a value for the KmsKeyId
parameter, then the following occurs:
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 not encrypted, then the restore request is
rejected.
kmsKeyId
- The AWS 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 is encrypted with the KMS key
identified by the KmsKeyId
parameter.
If you don't specify a value for the KmsKeyId
parameter, then the following occurs:
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 not encrypted, then the restore request
is rejected.
public String getKmsKeyId()
The AWS 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 is encrypted with the KMS key identified by the
KmsKeyId
parameter.
If you don't specify a value for the KmsKeyId
parameter, then the following occurs:
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 not 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 is encrypted with the KMS key
identified by the KmsKeyId
parameter.
If you don't specify a value for the KmsKeyId
parameter, then the following occurs:
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 not encrypted, then the restore
request is rejected.
public RestoreDBClusterToPointInTimeRequest withKmsKeyId(String kmsKeyId)
The AWS 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 is encrypted with the KMS key identified by the
KmsKeyId
parameter.
If you don't specify a value for the KmsKeyId
parameter, then the following occurs:
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 not encrypted, then the restore request is
rejected.
kmsKeyId
- The AWS 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 is encrypted with the KMS key
identified by the KmsKeyId
parameter.
If you don't specify a value for the KmsKeyId
parameter, then the following occurs:
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 not encrypted, then the restore request
is rejected.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public RestoreDBClusterToPointInTimeRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public void setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public Long getBacktrackWindow()
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public RestoreDBClusterToPointInTimeRequest withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public List<String> getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public RestoreDBClusterToPointInTimeRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEnableCloudwatchLogsExports(java.util.Collection)
or
withEnableCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public RestoreDBClusterToPointInTimeRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted,
the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public String getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public RestoreDBClusterToPointInTimeRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted,
the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public void setDeletionProtection(Boolean deletionProtection)
Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
deletionProtection
- Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when
this value is set to true. The default is false.public Boolean getDeletionProtection()
Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
public RestoreDBClusterToPointInTimeRequest withDeletionProtection(Boolean deletionProtection)
Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
deletionProtection
- Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when
this value is set to true. The default is false.public Boolean isDeletionProtection()
Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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.