com.amazonaws.services.rds.model

Class CopyDBSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.CopyDBSnapshotRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CopyDBSnapshotRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CopyDBSnapshot operation.

Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.

If you are copying from a shared manual DB snapshot, the SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.

See Also:

AmazonRDS.copyDBSnapshot(CopyDBSnapshotRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CopyDBSnapshotRequest()

Method Summary

Modifier and Type	Method and Description
CopyDBSnapshotRequest	clone()
boolean	equals(Object obj)
Boolean	getCopyTags() True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false.
String	getKmsKeyId() The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot.
String	getSourceDBSnapshotIdentifier() The identifier for the source DB snapshot.
List<Tag>	getTags() A list of tags.
String	getTargetDBSnapshotIdentifier() The identifier for the copied snapshot.
int	hashCode()
Boolean	isCopyTags() True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false.
void	setCopyTags(Boolean copyTags) True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false.
void	setKmsKeyId(String kmsKeyId) The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot.
void	setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier) The identifier for the source DB snapshot.
void	setTags(Collection<Tag> tags) A list of tags.
void	setTargetDBSnapshotIdentifier(String targetDBSnapshotIdentifier) The identifier for the copied snapshot.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CopyDBSnapshotRequest	withCopyTags(Boolean copyTags) True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false.
CopyDBSnapshotRequest	withKmsKeyId(String kmsKeyId) The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot.
CopyDBSnapshotRequest	withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier) The identifier for the source DB snapshot.
CopyDBSnapshotRequest	withTags(Collection<Tag> tags) A list of tags.
CopyDBSnapshotRequest	withTags(Tag... tags) A list of tags.
CopyDBSnapshotRequest	withTargetDBSnapshotIdentifier(String targetDBSnapshotIdentifier) The identifier for the copied snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CopyDBSnapshotRequest

public CopyDBSnapshotRequest()

Method Detail

getSourceDBSnapshotIdentifier

public String getSourceDBSnapshotIdentifier()

The identifier for the source DB snapshot.

If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

Constraints:

• Must specify a valid system snapshot in the "available" state.
• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
• If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

Returns:

The identifier for the source DB snapshot.

If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

Constraints:

• Must specify a valid system snapshot in the "available" state.
• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
• If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

setSourceDBSnapshotIdentifier

public void setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)

The identifier for the source DB snapshot.

If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

Constraints:

• Must specify a valid system snapshot in the "available" state.
• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
• If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

Parameters:

sourceDBSnapshotIdentifier - The identifier for the source DB snapshot.

If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

Constraints:

• Must specify a valid system snapshot in the "available" state.
• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
• If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

withSourceDBSnapshotIdentifier

public CopyDBSnapshotRequest withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)

The identifier for the source DB snapshot.

If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

Constraints:

• Must specify a valid system snapshot in the "available" state.
• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
• If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

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

Parameters:

sourceDBSnapshotIdentifier - The identifier for the source DB snapshot.

If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

Constraints:

• Must specify a valid system snapshot in the "available" state.
• If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
• If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

Returns:

A reference to this updated object so that method calls can be chained together.

getTargetDBSnapshotIdentifier

public String getTargetDBSnapshotIdentifier()

The identifier for the copied snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Returns:

The identifier for the copied snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

setTargetDBSnapshotIdentifier

public void setTargetDBSnapshotIdentifier(String targetDBSnapshotIdentifier)

The identifier for the copied snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Parameters:

targetDBSnapshotIdentifier - The identifier for the copied snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

withTargetDBSnapshotIdentifier

public CopyDBSnapshotRequest withTargetDBSnapshotIdentifier(String targetDBSnapshotIdentifier)

The identifier for the copied snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

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

Parameters:

targetDBSnapshotIdentifier - The identifier for the copied snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Returns:

A reference to this updated object so that method calls can be chained together.

getKmsKeyId

public String getKmsKeyId()

The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

Returns:

The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

Parameters:

kmsKeyId - The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

withKmsKeyId

public CopyDBSnapshotRequest withKmsKeyId(String kmsKeyId)

The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

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

Parameters:

kmsKeyId - The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public List<Tag> getTags()

A list of tags.

Returns:

A list of tags.

setTags

public void setTags(Collection<Tag> tags)

A list of tags.

Parameters:

tags - A list of tags.

withTags

public CopyDBSnapshotRequest withTags(Tag... tags)

A list of 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.

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

Parameters:

tags - A list of tags.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public CopyDBSnapshotRequest withTags(Collection<Tag> tags)

A list of tags.

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

Parameters:

tags - A list of tags.

Returns:

A reference to this updated object so that method calls can be chained together.

isCopyTags

public Boolean isCopyTags()

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

Returns:

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

setCopyTags

public void setCopyTags(Boolean copyTags)

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

Parameters:

copyTags - True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

withCopyTags

public CopyDBSnapshotRequest withCopyTags(Boolean copyTags)

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

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

Parameters:

copyTags - True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

Returns:

A reference to this updated object so that method calls can be chained together.

getCopyTags

public Boolean getCopyTags()

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

Returns:

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CopyDBSnapshotRequest clone()

Overrides:

clone in class AmazonWebServiceRequest