@Generated(value="software.amazon.awssdk:codegen") public final class RestoreDbClusterToPointInTimeRequest extends DocDbRequest implements ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
Represents the input to RestoreDBClusterToPointInTime.
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 cluster to be created.
|
String |
dbSubnetGroupName()
The subnet group name to use for the new cluster.
|
Boolean |
deletionProtection()
Specifies whether this cluster can be deleted.
|
List<String> |
enableCloudwatchLogsExports()
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasEnableCloudwatchLogsExports()
Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasVpcSecurityGroupIds()
Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
String |
kmsKeyId()
The AWS KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
|
Integer |
port()
The port number on which the new cluster accepts connections.
|
Instant |
restoreToTime()
The date and time to restore the cluster to.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> |
serializableBuilderClass() |
String |
sourceDBClusterIdentifier()
The identifier of the source cluster from which to restore.
|
List<Tag> |
tags()
The tags to be assigned to the restored cluster.
|
RestoreDbClusterToPointInTimeRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Boolean |
useLatestRestorableTime()
A value that is set to
true to restore the cluster to the latest restorable backup time, and
false otherwise. |
List<String> |
vpcSecurityGroupIds()
A list of VPC security groups that the new cluster belongs to.
|
overrideConfiguration
copy
public final String dbClusterIdentifier()
The name of the new cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The 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.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
public final String sourceDBClusterIdentifier()
The identifier of the source cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster
.
Constraints:
Must match the identifier of an existing DBCluster
.
public final Instant restoreToTime()
The date and time to restore the cluster to.
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
Must be before the latest restorable time for the instance.
Must be specified if the UseLatestRestorableTime
parameter is not provided.
Cannot be specified if the UseLatestRestorableTime
parameter is true
.
Cannot be specified if the RestoreType
parameter is copy-on-write
.
Example: 2015-03-07T23:45:00Z
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
Must be before the latest restorable time for the instance.
Must be specified if the UseLatestRestorableTime
parameter is not provided.
Cannot be specified if the UseLatestRestorableTime
parameter is true
.
Cannot be specified if the RestoreType
parameter is copy-on-write
.
Example: 2015-03-07T23:45:00Z
public final Boolean useLatestRestorableTime()
A value that is set to true
to restore the cluster to the latest restorable backup time, and
false
otherwise.
Default: false
Constraints: Cannot be specified if the RestoreToTime
parameter is provided.
true
to restore the cluster to the latest restorable backup time, and
false
otherwise.
Default: false
Constraints: Cannot be specified if the RestoreToTime
parameter is provided.
public final Integer port()
The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150
to 65535
.
Default: The default port for the engine.
Constraints: Must be a value from 1150
to 65535
.
Default: The default port for the engine.
public final String dbSubnetGroupName()
The subnet group name to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup
.
Example: mySubnetgroup
Constraints: If provided, must match the name of an existing DBSubnetGroup
.
Example: mySubnetgroup
public final boolean hasVpcSecurityGroupIds()
public final List<String> vpcSecurityGroupIds()
A list of VPC security groups that the new cluster belongs to.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasVpcSecurityGroupIds()
to see if a value was sent in this field.
public final boolean hasTags()
public final List<Tag> tags()
The tags to be assigned to the restored cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final String kmsKeyId()
The AWS KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an AWS KMS key that is different from the AWS
KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the AWS KMS key identified by
the KmsKeyId
parameter.
If you do not specify a value for the KmsKeyId
parameter, then the following occurs:
If the cluster is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the source cluster.
If the cluster is not encrypted, then the restored cluster is not encrypted.
If DBClusterIdentifier
refers to a cluster that is not encrypted, then the restore request is
rejected.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an AWS KMS key that is different from
the AWS KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the AWS KMS key
identified by the KmsKeyId
parameter.
If you do not specify a value for the KmsKeyId
parameter, then the following occurs:
If the cluster is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the source cluster.
If the cluster is not encrypted, then the restored cluster is not encrypted.
If DBClusterIdentifier
refers to a cluster that is not encrypted, then the restore request
is rejected.
public final boolean hasEnableCloudwatchLogsExports()
public final List<String> enableCloudwatchLogsExports()
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnableCloudwatchLogsExports()
to see if a value was sent in this field.
public final Boolean deletionProtection()
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot
be deleted unless it is modified and DeletionProtection
is disabled. DeletionProtection
protects clusters from being accidentally deleted.
DeletionProtection
is enabled, the cluster
cannot be deleted unless it is modified and DeletionProtection
is disabled.
DeletionProtection
protects clusters from being accidentally deleted.public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
toBuilder
in class DocDbRequest
public static RestoreDbClusterToPointInTimeRequest.Builder builder()
public static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <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 © 2021 Amazon Web Services, Inc. All Rights Reserved.