@Generated(value="software.amazon.awssdk:codegen") public final class RestoreDbClusterToPointInTimeRequest extends RdsRequest implements ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
RestoreDbClusterToPointInTimeRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static RestoreDbClusterToPointInTimeRequest.Builder |
builder() |
String |
dbClusterIdentifier()
The name of the new DB cluster to be created.
|
String |
dbSubnetGroupName()
The DB subnet group name to use for the new DB cluster.
|
Boolean |
enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
kmsKeyId()
The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
|
String |
optionGroupName()
The name of the option group for the new DB cluster.
|
Integer |
port()
The port number on which the new DB cluster accepts connections.
|
Instant |
restoreToTime()
The date and time to restore the DB cluster to.
|
String |
restoreType()
The type of restore to be performed.
|
static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> |
serializableBuilderClass() |
String |
sourceDBClusterIdentifier()
The identifier of the source DB cluster from which to restore.
|
List<Tag> |
tags()
Returns the value of the Tags property for this object.
|
RestoreDbClusterToPointInTimeRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
useLatestRestorableTime()
A value that is set to
true to restore the DB cluster to the latest restorable backup time, and
false otherwise. |
List<String> |
vpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster belongs to.
|
overrideConfiguration
copy
public 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
Cannot 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
Cannot end with a hyphen or contain two consecutive hyphens
public 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.
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 sourceDBClusterIdentifier()
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 Instant 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
Cannot be specified if UseLatestRestorableTime
parameter is true
Cannot 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
Cannot be specified if UseLatestRestorableTime
parameter is true
Cannot be specified if RestoreType
parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
public 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.
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 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.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
public 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
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public String optionGroupName()
The name of the option group for the new DB cluster.
public List<String> vpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster belongs to.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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 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 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 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 not encrypted, then the restore
request is rejected.
public Boolean enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
toBuilder
in class RdsRequest
public static RestoreDbClusterToPointInTimeRequest.Builder builder()
public static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.