RestoreDbClusterToPointInTimeRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.neptune.model.NeptuneRequest
    - - software.amazon.awssdk.services.neptune.model.RestoreDbClusterToPointInTimeRequest

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

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreDbClusterToPointInTimeRequest
extends NeptuneRequest
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
`static RestoreDbClusterToPointInTimeRequest.Builder`	`builder()`
`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 the new 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.
`List<String>`	`enableCloudwatchLogsExports()` The list of logs that the restored DB cluster is to export to CloudWatch Logs.
`Boolean`	`enableIAMDatabaseAuthentication()` True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
`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 KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
`String`	`optionGroupName()` (Not supported by Neptune)
`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.
`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()` The tags to be applied to the restored DB cluster.
`RestoreDbClusterToPointInTimeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`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.

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
    - Cannot 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
    
    Cannot 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.
    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.
    
    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 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
    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 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
  - useLatestRestorableTime
```
public final 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.
    
    Returns:
    
    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.
  - port
```
public final 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.
    
    Returns:
    
    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.
  - 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()
```
    (Not supported by Neptune)
    
    Returns:
    
    (Not supported by Neptune)
  - 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()
```
    The tags to be applied to the restored DB 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 applied to the restored DB cluster.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The Amazon 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 Amazon 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.
    Returns:
    The Amazon 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 Amazon 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.
  - enableIAMDatabaseAuthentication
```
public final Boolean enableIAMDatabaseAuthentication()
```
    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
    
    Returns:
    
    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
  - 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.
    
    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.
  - dbClusterParameterGroupName
```
public final String dbClusterParameterGroupName()
```
    The name of the DB cluster parameter group to associate with the new DB cluster.
    
    Constraints:
    - If supplied, must match the name of an existing DBClusterParameterGroup.
    Returns:
    The name of the DB cluster parameter group to associate with the new DB cluster.
    
    Constraints:
    
    If supplied, must match the name of an existing DBClusterParameterGroup.
  - 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.
  - toBuilder
```
public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
    
    Specified by:
    
    toBuilder in class NeptuneRequest
  - 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

hasEnableCloudwatchLogsExports

enableCloudwatchLogsExports

dbClusterParameterGroupName

deletionProtection

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields