@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 |
---|---|
Long |
backtrackWindow()
The target backtrack window, in seconds.
|
static RestoreDbClusterToPointInTimeRequest.Builder |
builder() |
Boolean |
copyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
String |
dbClusterIdentifier()
The name of the new DB cluster to be created.
|
String |
dbClusterInstanceClass()
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
String |
dbClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
dbSubnetGroupName()
The DB subnet group name to use for the new DB cluster.
|
Boolean |
deletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
String |
domain()
Specify the Active Directory directory ID to restore the DB cluster in.
|
String |
domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
enableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
|
Boolean |
enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
String |
engineMode()
The engine mode of the new cluster.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasEnableCloudwatchLogsExports()
For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
|
Integer |
iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
|
String |
kmsKeyId()
The Amazon Web Services 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.
|
Boolean |
publiclyAccessible()
A value that indicates whether the DB cluster is publicly accessible.
|
Instant |
restoreToTime()
The date and time to restore the DB cluster to.
|
String |
restoreType()
The type of restore to be performed.
|
ScalingConfiguration |
scalingConfiguration()
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> |
serializableBuilderClass() |
String |
sourceDBClusterIdentifier()
The identifier of the source DB cluster from which to restore.
|
String |
storageType()
Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
|
List<Tag> |
tags()
Returns the value of the Tags property for this object.
|
RestoreDbClusterToPointInTimeRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
useLatestRestorableTime()
A value that indicates whether to restore the DB cluster to the latest restorable backup time.
|
List<String> |
vpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster belongs to.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final String sourceDBClusterIdentifier()
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final 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 isn't provided
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Can't be specified if the RestoreType
parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 isn't provided
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Can't be specified if the RestoreType
parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final Boolean useLatestRestorableTime()
A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime
parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints: Can't be specified if RestoreToTime
parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final 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: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final String optionGroupName()
The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
DB clusters are associated with a default option group that can't be modified.
public final boolean hasVpcSecurityGroupIds()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> vpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds()
method.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final boolean hasTags()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags()
method.
public final String kmsKeyId()
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from 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 isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier
refers to a DB cluster that isn't encrypted, then the restore request is
rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from
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 isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier
refers to a DB cluster that isn't encrypted, then the restore request
is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final Boolean enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public final 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).
Valid for: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
public final boolean hasEnableCloudwatchLogsExports()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEnableCloudwatchLogsExports()
method.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final Boolean deletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final Boolean copyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Valid for: Aurora DB clusters and Multi-AZ DB clusters
public final String domain()
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
public final String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public final ScalingConfiguration scalingConfiguration()
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
public final String engineMode()
The engine mode of the new cluster. Specify provisioned
or serverless
, depending on the
type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or
a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1
cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
provisioned
or serverless
,
depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from
a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone
that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or
an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
public final String dbClusterInstanceClass()
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
public final String storageType()
Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops
parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
Valid values: io1
When specified, a value for the Iops
parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
public final Boolean publiclyAccessible()
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified,
the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
public final Integer iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid Iops
values, see Amazon RDS Provisioned
IOPS storage to improve performance in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
For information about valid Iops
values, see Amazon RDS
Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
toBuilder
in class RdsRequest
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)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.