RestoreDbClusterToPointInTimeRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.RestoreDbClusterToPointInTimeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreDbClusterToPointInTimeRequest
extends RdsRequest
implements ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RestoreDbClusterToPointInTimeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RestoreDbClusterToPointInTimeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`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()` 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 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.
`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.
`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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbClusterIdentifier
```
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
    Returns:
    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
  - restoreType
```
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.
    Returns:
    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.
  - sourceDBClusterIdentifier
```
public final String sourceDBClusterIdentifier()
```
    The identifier of the source DB cluster from which to restore.
    
    Constraints:
    - Must match the identifier of an existing DBCluster.
    Returns:
    The identifier of the source DB cluster from which to restore.
    
    Constraints:
    
    Must match the identifier of an existing DBCluster.
  - restoreToTime
```
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
    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
    
    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
  - useLatestRestorableTime
```
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.
    
    Returns:
    
    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.
  - port
```
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.
    
    Returns:
    
    The port number on which the new DB cluster accepts connections.
    
    Constraints: A value from 1150-65535.
    
    Default: The default port for the engine.
  - dbSubnetGroupName
```
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: mySubnetgroup
    
    Returns:
    
    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
  - optionGroupName
```
public final String optionGroupName()
```
    The name of the option group for the new DB cluster.
    
    Returns:
    
    The name of the option group for the new DB cluster.
  - hasVpcSecurityGroupIds
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - vpcSecurityGroupIds
```
public final 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.
    
    You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    A list of VPC security groups that the new DB cluster belongs to.
  - hasTags
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    Returns the value of the Tags property for this object.
    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.
    
    Returns:
    
    The value of the Tags property for this object.
  - kmsKeyId
```
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 Amazon Web Services KMS customer master key (CMK). To use a CMK 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 Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.
    Returns:
    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 Amazon Web Services KMS customer master key (CMK). To use a CMK 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 Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.
  - enableIAMDatabaseAuthentication
```
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 is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Returns:
    
    A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
  - backtrackWindow
```
public final Long backtrackWindow()
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Returns:
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    
    Constraints:
    
    If specified, this value must be set to a number from 0 to 259,200 (72 hours).
  - hasEnableCloudwatchLogsExports
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - enableCloudwatchLogsExports
```
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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    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.
    
    Returns:
    
    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.
  - dbClusterParameterGroupName
```
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.
    Returns:
    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.
  - deletionProtection
```
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 is disabled.
    
    Returns:
    
    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 is disabled.
  - copyTagsToSnapshot
```
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.
    
    Returns:
    
    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.
  - domain
```
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.
    
    Returns:
    
    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.
  - domainIAMRoleName
```
public final String domainIAMRoleName()
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Returns:
    
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
  - scalingConfiguration
```
public final ScalingConfiguration scalingConfiguration()
```
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
    
    Returns:
    
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
  - engineMode
```
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 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.
    
    Returns:
    
    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 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.
  - toBuilder
```
public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static RestoreDbClusterToPointInTimeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RestoreDbClusterToPointInTimeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbClusterIdentifier

restoreType

sourceDBClusterIdentifier

restoreToTime

useLatestRestorableTime

port

dbSubnetGroupName

optionGroupName

hasVpcSecurityGroupIds

vpcSecurityGroupIds

hasTags

tags

kmsKeyId

enableIAMDatabaseAuthentication

backtrackWindow

hasEnableCloudwatchLogsExports

enableCloudwatchLogsExports

dbClusterParameterGroupName

deletionProtection

copyTagsToSnapshot

domain

domainIAMRoleName

scalingConfiguration

engineMode

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields