Package software.amazon.awssdk.services.rds.model

Class RestoreDBClusterToPointInTimeRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.RestoreDBClusterToPointInTimeRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<RestoreDBClusterToPointInTimeRequest.Builder,RestoreDBClusterToPointInTimeRequest>

@Generated("software.amazon.awssdk:codegen")
public class RestoreDBClusterToPointInTimeRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<RestoreDBClusterToPointInTimeRequest.Builder,RestoreDBClusterToPointInTimeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestoreDBClusterToPointInTimeRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static RestoreDBClusterToPointInTimeRequest.Builder	builder()
String	dbClusterIdentifier()	The name of the new DB cluster to be created.
String	dbSubnetGroupName()	The DB subnet group name to use for the new DB cluster.
Boolean	enableIAMDatabaseAuthentication()	A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
boolean	equals(Object obj)
int	hashCode()
String	kmsKeyId()	The 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.
Date	restoreToTime()	The date and time to restore the DB cluster to.
String	restoreType()	The type of restore to be performed.
static Class<? extends RestoreDBClusterToPointInTimeRequest.Builder>	serializableBuilderClass()
String	sourceDBClusterIdentifier()	The identifier of the source DB cluster from which to restore.
List<Tag>	tags()
RestoreDBClusterToPointInTimeRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dbClusterIdentifier

public String dbClusterIdentifier()

The name of the new DB cluster to be created.

Constraints:

• Must contain from 1 to 63 alphanumeric characters 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 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

restoreType

public 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 cannot 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 cannot 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 String sourceDBClusterIdentifier()

The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

restoreToTime

public Date 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 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 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 String dbSubnetGroupName()

The DB subnet group name to use for the new DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Returns:

The DB subnet group name to use for the new DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

optionGroupName

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

vpcSecurityGroupIds

public List<String> vpcSecurityGroupIds()

A list of VPC security groups that the new DB cluster belongs to.

Returns:

A list of VPC security groups that the new DB cluster belongs to.

tags

public List<Tag> tags()

Returns:

kmsKeyId

public String kmsKeyId()

The 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 AWS 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 will be 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 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 AWS 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 will be 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 Boolean enableIAMDatabaseAuthentication()

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

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>

Returns:

a builder for type T

builder

public static RestoreDBClusterToPointInTimeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RestoreDBClusterToPointInTimeRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object