RestoreDbClusterToPointInTimeRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.docdb.model.DocDbRequest
    - - software.amazon.awssdk.services.docdb.model.RestoreDbClusterToPointInTimeRequest

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

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

Represents the input to RestoreDBClusterToPointInTime.

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
`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.

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

Methods inherited from class java.lang.Object
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 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.
    Returns:
    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.
  - sourceDBClusterIdentifier
```
public final String sourceDBClusterIdentifier()
```
    The identifier of the source cluster from which to restore.
    
    Constraints:
    - Must match the identifier of an existing DBCluster.
    Returns:
    The identifier of the source 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 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
    Returns:
    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
  - useLatestRestorableTime
```
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.
    
    Returns:
    
    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.
  - port
```
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.
    
    Returns:
    
    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.
  - dbSubnetGroupName
```
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
    
    Returns:
    
    The subnet group name to use for the new cluster.
    
    Constraints: If provided, must match the name of an existing DBSubnetGroup.
    
    Example: mySubnetgroup
  - 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 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 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()
```
    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.
    
    Returns:
    
    The tags to be assigned to the restored cluster.
  - kmsKeyId
```
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.
    Returns:
    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.
  - 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()
```
    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.
    
    Returns:
    
    A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
  - deletionProtection
```
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.
    
    Returns:
    
    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.
  - toBuilder
```
public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
    
    Specified by:
    
    toBuilder in class DocDbRequest
    
    Returns:
    
    a builder for type T
  - 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.62

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

sourceDBClusterIdentifier

restoreToTime

useLatestRestorableTime

port

dbSubnetGroupName

hasVpcSecurityGroupIds

vpcSecurityGroupIds

hasTags

tags

kmsKeyId

hasEnableCloudwatchLogsExports

enableCloudwatchLogsExports

deletionProtection

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields