com.amazonaws.services.neptune.model

Class RestoreDBClusterFromSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.neptune.model.RestoreDBClusterFromSnapshotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RestoreDBClusterFromSnapshotRequest
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
RestoreDBClusterFromSnapshotRequest()

Method Summary

Modifier and Type	Method and Description
RestoreDBClusterFromSnapshotRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAvailabilityZones() Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
Boolean	getCopyTagsToSnapshot() If set to true, tags are copied to any snapshot of the restored DB cluster that is created.
String	getDatabaseName() Not supported.
String	getDBClusterIdentifier() The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
String	getDBClusterParameterGroupName() The name of the DB cluster parameter group to associate with the new DB cluster.
String	getDBSubnetGroupName() The name of the DB subnet group to use for the new DB cluster.
Boolean	getDeletionProtection() A value that indicates whether the DB cluster has deletion protection enabled.
List<String>	getEnableCloudwatchLogsExports() The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
Boolean	getEnableIAMDatabaseAuthentication() True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
String	getEngine() The database engine to use for the new DB cluster.
String	getEngineVersion() The version of the database engine to use for the new DB cluster.
String	getKmsKeyId() The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
String	getOptionGroupName() (Not supported by Neptune)
Integer	getPort() The port number on which the new DB cluster accepts connections.
ServerlessV2ScalingConfiguration	getServerlessV2ScalingConfiguration() Contains the scaling configuration of a Neptune Serverless DB cluster.
String	getSnapshotIdentifier() The identifier for the DB snapshot or DB cluster snapshot to restore from.
String	getStorageType() Specifies the storage type to be associated with the DB cluster.
List<Tag>	getTags() The tags to be assigned to the restored DB cluster.
List<String>	getVpcSecurityGroupIds() A list of VPC security groups that the new DB cluster will belong to.
int	hashCode()
Boolean	isCopyTagsToSnapshot() If set to true, tags are copied to any snapshot of the restored DB cluster that is created.
Boolean	isDeletionProtection() A value that indicates whether the DB cluster has deletion protection enabled.
Boolean	isEnableIAMDatabaseAuthentication() True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
void	setAvailabilityZones(Collection<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
void	setCopyTagsToSnapshot(Boolean copyTagsToSnapshot) If set to true, tags are copied to any snapshot of the restored DB cluster that is created.
void	setDatabaseName(String databaseName) Not supported.
void	setDBClusterIdentifier(String dBClusterIdentifier) The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
void	setDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of the DB cluster parameter group to associate with the new DB cluster.
void	setDBSubnetGroupName(String dBSubnetGroupName) The name of the DB subnet group to use for the new DB cluster.
void	setDeletionProtection(Boolean deletionProtection) A value that indicates whether the DB cluster has deletion protection enabled.
void	setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports) The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
void	setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
void	setEngine(String engine) The database engine to use for the new DB cluster.
void	setEngineVersion(String engineVersion) The version of the database engine to use for the new DB cluster.
void	setKmsKeyId(String kmsKeyId) The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
void	setOptionGroupName(String optionGroupName) (Not supported by Neptune)
void	setPort(Integer port) The port number on which the new DB cluster accepts connections.
void	setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) Contains the scaling configuration of a Neptune Serverless DB cluster.
void	setSnapshotIdentifier(String snapshotIdentifier) The identifier for the DB snapshot or DB cluster snapshot to restore from.
void	setStorageType(String storageType) Specifies the storage type to be associated with the DB cluster.
void	setTags(Collection<Tag> tags) The tags to be assigned to the restored DB cluster.
void	setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.
String	toString() Returns a string representation of this object.
RestoreDBClusterFromSnapshotRequest	withAvailabilityZones(Collection<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
RestoreDBClusterFromSnapshotRequest	withAvailabilityZones(String... availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
RestoreDBClusterFromSnapshotRequest	withCopyTagsToSnapshot(Boolean copyTagsToSnapshot) If set to true, tags are copied to any snapshot of the restored DB cluster that is created.
RestoreDBClusterFromSnapshotRequest	withDatabaseName(String databaseName) Not supported.
RestoreDBClusterFromSnapshotRequest	withDBClusterIdentifier(String dBClusterIdentifier) The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
RestoreDBClusterFromSnapshotRequest	withDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of the DB cluster parameter group to associate with the new DB cluster.
RestoreDBClusterFromSnapshotRequest	withDBSubnetGroupName(String dBSubnetGroupName) The name of the DB subnet group to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest	withDeletionProtection(Boolean deletionProtection) A value that indicates whether the DB cluster has deletion protection enabled.
RestoreDBClusterFromSnapshotRequest	withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports) The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
RestoreDBClusterFromSnapshotRequest	withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports) The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
RestoreDBClusterFromSnapshotRequest	withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
RestoreDBClusterFromSnapshotRequest	withEngine(String engine) The database engine to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest	withEngineVersion(String engineVersion) The version of the database engine to use for the new DB cluster.
RestoreDBClusterFromSnapshotRequest	withKmsKeyId(String kmsKeyId) The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
RestoreDBClusterFromSnapshotRequest	withOptionGroupName(String optionGroupName) (Not supported by Neptune)
RestoreDBClusterFromSnapshotRequest	withPort(Integer port) The port number on which the new DB cluster accepts connections.
RestoreDBClusterFromSnapshotRequest	withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) Contains the scaling configuration of a Neptune Serverless DB cluster.
RestoreDBClusterFromSnapshotRequest	withSnapshotIdentifier(String snapshotIdentifier) The identifier for the DB snapshot or DB cluster snapshot to restore from.
RestoreDBClusterFromSnapshotRequest	withStorageType(String storageType) Specifies the storage type to be associated with the DB cluster.
RestoreDBClusterFromSnapshotRequest	withTags(Collection<Tag> tags) The tags to be assigned to the restored DB cluster.
RestoreDBClusterFromSnapshotRequest	withTags(Tag... tags) The tags to be assigned to the restored DB cluster.
RestoreDBClusterFromSnapshotRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.
RestoreDBClusterFromSnapshotRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong 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

RestoreDBClusterFromSnapshotRequest

public RestoreDBClusterFromSnapshotRequest()

Method Detail

getAvailabilityZones

public List<String> getAvailabilityZones()

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

setAvailabilityZones

public void setAvailabilityZones(Collection<String> availabilityZones)

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

Parameters:

availabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

withAvailabilityZones

public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(String... availabilityZones)

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

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

Parameters:

availabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

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

withAvailabilityZones

public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(Collection<String> availabilityZones)

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

Parameters:

availabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

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

setDBClusterIdentifier

public void setDBClusterIdentifier(String dBClusterIdentifier)

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

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

Example: my-snapshot-id

Parameters:

dBClusterIdentifier - The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

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

Example: my-snapshot-id

getDBClusterIdentifier

public String getDBClusterIdentifier()

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

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

Example: my-snapshot-id

Returns:

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

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

Example: my-snapshot-id

withDBClusterIdentifier

public RestoreDBClusterFromSnapshotRequest withDBClusterIdentifier(String dBClusterIdentifier)

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

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

Example: my-snapshot-id

Parameters:

dBClusterIdentifier - The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

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

Example: my-snapshot-id

Returns:

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

setSnapshotIdentifier

public void setSnapshotIdentifier(String snapshotIdentifier)

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

Parameters:

snapshotIdentifier - The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

getSnapshotIdentifier

public String getSnapshotIdentifier()

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

Returns:

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

withSnapshotIdentifier

public RestoreDBClusterFromSnapshotRequest withSnapshotIdentifier(String snapshotIdentifier)

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

Parameters:

snapshotIdentifier - The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

Returns:

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

setEngine

public void setEngine(String engine)

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Parameters:

engine - The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

getEngine

public String getEngine()

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Returns:

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

withEngine

public RestoreDBClusterFromSnapshotRequest withEngine(String engine)

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Parameters:

engine - The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Returns:

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

setEngineVersion

public void setEngineVersion(String engineVersion)

The version of the database engine to use for the new DB cluster.

Parameters:

engineVersion - The version of the database engine to use for the new DB cluster.

getEngineVersion

public String getEngineVersion()

The version of the database engine to use for the new DB cluster.

Returns:

The version of the database engine to use for the new DB cluster.

withEngineVersion

public RestoreDBClusterFromSnapshotRequest withEngineVersion(String engineVersion)

The version of the database engine to use for the new DB cluster.

Parameters:

engineVersion - The version of the database engine to use for the new DB cluster.

Returns:

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

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 RestoreDBClusterFromSnapshotRequest 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 name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Parameters:

dBSubnetGroupName - The name of the DB subnet group 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 name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Returns:

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

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

withDBSubnetGroupName

public RestoreDBClusterFromSnapshotRequest withDBSubnetGroupName(String dBSubnetGroupName)

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

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Parameters:

dBSubnetGroupName - The name of the DB subnet group 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.

setDatabaseName

public void setDatabaseName(String databaseName)

Not supported.

Parameters:

databaseName - Not supported.

getDatabaseName

public String getDatabaseName()

Not supported.

Returns:

Not supported.

withDatabaseName

public RestoreDBClusterFromSnapshotRequest withDatabaseName(String databaseName)

Not supported.

Parameters:

databaseName - Not supported.

Returns:

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

setOptionGroupName

public void setOptionGroupName(String optionGroupName)

(Not supported by Neptune)

Parameters:

optionGroupName - (Not supported by Neptune)

getOptionGroupName

public String getOptionGroupName()

(Not supported by Neptune)

Returns:

(Not supported by Neptune)

withOptionGroupName

public RestoreDBClusterFromSnapshotRequest withOptionGroupName(String optionGroupName)

(Not supported by Neptune)

Parameters:

optionGroupName - (Not supported by Neptune)

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 will belong to.

Returns:

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

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

Parameters:

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

withVpcSecurityGroupIds

public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

A list of VPC security groups that the new DB cluster will belong 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 will belong to.

Returns:

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

withVpcSecurityGroupIds

public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

Parameters:

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

Returns:

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

getTags

public List<Tag> getTags()

The tags to be assigned to the restored DB cluster.

Returns:

The tags to be assigned to the restored DB cluster.

setTags

public void setTags(Collection<Tag> tags)

The tags to be assigned to the restored DB cluster.

Parameters:

tags - The tags to be assigned to the restored DB cluster.

withTags

public RestoreDBClusterFromSnapshotRequest withTags(Tag... tags)

The tags to be assigned to the restored DB cluster.

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 - The tags to be assigned to the restored DB cluster.

Returns:

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

withTags

public RestoreDBClusterFromSnapshotRequest withTags(Collection<Tag> tags)

The tags to be assigned to the restored DB cluster.

Parameters:

tags - The tags to be assigned to the restored DB cluster.

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Parameters:

kmsKeyId - The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

getKmsKeyId

public String getKmsKeyId()

The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Returns:

The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

withKmsKeyId

public RestoreDBClusterFromSnapshotRequest withKmsKeyId(String kmsKeyId)

The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Parameters:

kmsKeyId - The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Returns:

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

setEnableIAMDatabaseAuthentication

public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

getEnableIAMDatabaseAuthentication

public Boolean getEnableIAMDatabaseAuthentication()

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

withEnableIAMDatabaseAuthentication

public RestoreDBClusterFromSnapshotRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - True to enable mapping of Amazon 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()

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

getEnableCloudwatchLogsExports

public List<String> getEnableCloudwatchLogsExports()

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

Returns:

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

setEnableCloudwatchLogsExports

public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

Parameters:

enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

withEnableCloudwatchLogsExports

public RestoreDBClusterFromSnapshotRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

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

Parameters:

enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

Returns:

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

withEnableCloudwatchLogsExports

public RestoreDBClusterFromSnapshotRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

Parameters:

enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

Returns:

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

setDBClusterParameterGroupName

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

Parameters:

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.

getDBClusterParameterGroupName

public String getDBClusterParameterGroupName()

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.

withDBClusterParameterGroupName

public RestoreDBClusterFromSnapshotRequest withDBClusterParameterGroupName(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.

Parameters:

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:

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

setDeletionProtection

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

Parameters:

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.

getDeletionProtection

public Boolean getDeletionProtection()

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.

withDeletionProtection

public RestoreDBClusterFromSnapshotRequest withDeletionProtection(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.

Parameters:

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:

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

isDeletionProtection

public Boolean isDeletionProtection()

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.

setCopyTagsToSnapshot

public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

Parameters:

copyTagsToSnapshot - If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

getCopyTagsToSnapshot

public Boolean getCopyTagsToSnapshot()

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

Returns:

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

withCopyTagsToSnapshot

public RestoreDBClusterFromSnapshotRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

Parameters:

copyTagsToSnapshot - If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

Returns:

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

isCopyTagsToSnapshot

public Boolean isCopyTagsToSnapshot()

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

Returns:

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

setServerlessV2ScalingConfiguration

public void setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

Parameters:

serverlessV2ScalingConfiguration - Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

getServerlessV2ScalingConfiguration

public ServerlessV2ScalingConfiguration getServerlessV2ScalingConfiguration()

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

Returns:

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

withServerlessV2ScalingConfiguration

public RestoreDBClusterFromSnapshotRequest withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

Parameters:

serverlessV2ScalingConfiguration - Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

Returns:

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

setStorageType

public void setStorageType(String storageType)

Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

Parameters:

storageType - Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

getStorageType

public String getStorageType()

Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

Returns:

Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

withStorageType

public RestoreDBClusterFromSnapshotRequest withStorageType(String storageType)

Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

Parameters:

storageType - Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

Returns:

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

toString

public 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

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 RestoreDBClusterFromSnapshotRequest 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()