com.amazonaws.services.rds.model

Class RestoreDBClusterToPointInTimeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.RestoreDBClusterToPointInTimeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RestoreDBClusterToPointInTimeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RestoreDBClusterToPointInTimeRequest()

Method Summary

Modifier and Type	Method and Description
RestoreDBClusterToPointInTimeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDBClusterIdentifier() The name of the new DB cluster to be created.
String	getDBSubnetGroupName() The DB subnet group name to use for the new DB cluster.
Boolean	getEnableIAMDatabaseAuthentication() A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
String	getKmsKeyId() The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
String	getOptionGroupName() The name of the option group for the new DB cluster.
Integer	getPort() The port number on which the new DB cluster accepts connections.
Date	getRestoreToTime() The date and time to restore the DB cluster to.
String	getRestoreType() The type of restore to be performed.
String	getSourceDBClusterIdentifier() The identifier of the source DB cluster from which to restore.
List<Tag>	getTags()
Boolean	getUseLatestRestorableTime() A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
List<String>	getVpcSecurityGroupIds() A list of VPC security groups that the new DB cluster belongs to.
int	hashCode()
Boolean	isEnableIAMDatabaseAuthentication() A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Boolean	isUseLatestRestorableTime() A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
void	setDBClusterIdentifier(String dBClusterIdentifier) The name of the new DB cluster to be created.
void	setDBSubnetGroupName(String dBSubnetGroupName) The DB subnet group name to use for the new DB cluster.
void	setEnableIAMDatabaseAuthentication(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.
void	setKmsKeyId(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
void	setOptionGroupName(String optionGroupName) The name of the option group for the new DB cluster.
void	setPort(Integer port) The port number on which the new DB cluster accepts connections.
void	setRestoreToTime(Date restoreToTime) The date and time to restore the DB cluster to.
void	setRestoreType(String restoreType) The type of restore to be performed.
void	setSourceDBClusterIdentifier(String sourceDBClusterIdentifier) The identifier of the source DB cluster from which to restore.
void	setTags(Collection<Tag> tags)
void	setUseLatestRestorableTime(Boolean useLatestRestorableTime) A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
void	setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster belongs to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RestoreDBClusterToPointInTimeRequest	withDBClusterIdentifier(String dBClusterIdentifier) The name of the new DB cluster to be created.
RestoreDBClusterToPointInTimeRequest	withDBSubnetGroupName(String dBSubnetGroupName) The DB subnet group name to use for the new DB cluster.
RestoreDBClusterToPointInTimeRequest	withEnableIAMDatabaseAuthentication(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.
RestoreDBClusterToPointInTimeRequest	withKmsKeyId(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
RestoreDBClusterToPointInTimeRequest	withOptionGroupName(String optionGroupName) The name of the option group for the new DB cluster.
RestoreDBClusterToPointInTimeRequest	withPort(Integer port) The port number on which the new DB cluster accepts connections.
RestoreDBClusterToPointInTimeRequest	withRestoreToTime(Date restoreToTime) The date and time to restore the DB cluster to.
RestoreDBClusterToPointInTimeRequest	withRestoreType(String restoreType) The type of restore to be performed.
RestoreDBClusterToPointInTimeRequest	withSourceDBClusterIdentifier(String sourceDBClusterIdentifier) The identifier of the source DB cluster from which to restore.
RestoreDBClusterToPointInTimeRequest	withTags(Collection<Tag> tags)
RestoreDBClusterToPointInTimeRequest	withTags(Tag... tags) NOTE: This method appends the values to the existing list (if any).
RestoreDBClusterToPointInTimeRequest	withUseLatestRestorableTime(Boolean useLatestRestorableTime) A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
RestoreDBClusterToPointInTimeRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster belongs to.
RestoreDBClusterToPointInTimeRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster belongs to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreDBClusterToPointInTimeRequest

public RestoreDBClusterToPointInTimeRequest()

Method Detail

setDBClusterIdentifier

public void setDBClusterIdentifier(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

Parameters:

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

getDBClusterIdentifier

public String getDBClusterIdentifier()

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

withDBClusterIdentifier

public RestoreDBClusterToPointInTimeRequest withDBClusterIdentifier(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setRestoreType

public void setRestoreType(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.

Parameters:

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.

getRestoreType

public String getRestoreType()

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.

withRestoreType

public RestoreDBClusterToPointInTimeRequest withRestoreType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSourceDBClusterIdentifier

public void setSourceDBClusterIdentifier(String sourceDBClusterIdentifier)

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

Constraints:

• Must match the identifier of an existing DBCluster.

Parameters:

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

Constraints:

• Must match the identifier of an existing DBCluster.

getSourceDBClusterIdentifier

public String getSourceDBClusterIdentifier()

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.

withSourceDBClusterIdentifier

public RestoreDBClusterToPointInTimeRequest withSourceDBClusterIdentifier(String sourceDBClusterIdentifier)

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

Constraints:

• Must match the identifier of an existing DBCluster.

Parameters:

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

Constraints:

• Must match the identifier of an existing DBCluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRestoreToTime

public void setRestoreToTime(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

Parameters:

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

getRestoreToTime

public Date getRestoreToTime()

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

withRestoreToTime

public RestoreDBClusterToPointInTimeRequest withRestoreToTime(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setUseLatestRestorableTime

public void setUseLatestRestorableTime(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.

Parameters:

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.

getUseLatestRestorableTime

public Boolean getUseLatestRestorableTime()

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.

withUseLatestRestorableTime

public RestoreDBClusterToPointInTimeRequest withUseLatestRestorableTime(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isUseLatestRestorableTime

public Boolean isUseLatestRestorableTime()

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.

setPort

public void setPort(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.

Parameters:

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.

getPort

public Integer getPort()

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.

withPort

public RestoreDBClusterToPointInTimeRequest withPort(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDBSubnetGroupName

public void setDBSubnetGroupName(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

Parameters:

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

getDBSubnetGroupName

public String getDBSubnetGroupName()

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

withDBSubnetGroupName

public RestoreDBClusterToPointInTimeRequest withDBSubnetGroupName(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setOptionGroupName

public void setOptionGroupName(String optionGroupName)

The name of the option group for the new DB cluster.

Parameters:

optionGroupName - The name of the option group for the new DB cluster.

getOptionGroupName

public String getOptionGroupName()

The name of the option group for the new DB cluster.

Returns:

The name of the option group for the new DB cluster.

withOptionGroupName

public RestoreDBClusterToPointInTimeRequest withOptionGroupName(String optionGroupName)

The name of the option group for the new DB cluster.

Parameters:

optionGroupName - The name of the option group for the new DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

getVpcSecurityGroupIds

public List<String> getVpcSecurityGroupIds()

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.

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

Parameters:

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

withVpcSecurityGroupIds

public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

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

NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withVpcSecurityGroupIds

public RestoreDBClusterToPointInTimeRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Returns:

setTags

public void setTags(Collection<Tag> tags)

Parameters:

tags -

withTags

public RestoreDBClusterToPointInTimeRequest withTags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public RestoreDBClusterToPointInTimeRequest withTags(Collection<Tag> tags)

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(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 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.

Parameters:

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

getKmsKeyId

public String getKmsKeyId()

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

withKmsKeyId

public RestoreDBClusterToPointInTimeRequest withKmsKeyId(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 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.

Parameters:

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 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:

Returns a reference to this object so that method calls can be chained together.

setEnableIAMDatabaseAuthentication

public void setEnableIAMDatabaseAuthentication(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

Parameters:

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

getEnableIAMDatabaseAuthentication

public Boolean getEnableIAMDatabaseAuthentication()

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

withEnableIAMDatabaseAuthentication

public RestoreDBClusterToPointInTimeRequest withEnableIAMDatabaseAuthentication(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isEnableIAMDatabaseAuthentication

public Boolean isEnableIAMDatabaseAuthentication()

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RestoreDBClusterToPointInTimeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()