com.amazonaws.services.docdbelastic.model

Class CopyClusterSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdbelastic.model.CopyClusterSnapshotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CopyClusterSnapshotRequest	addTagsEntry(String key, String value) Add a single Tags entry
CopyClusterSnapshotRequest	clearTagsEntries() Removes all the entries added into Tags.
CopyClusterSnapshotRequest	clone()
boolean	equals(Object obj)
Boolean	getCopyTags() Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot.
String	getKmsKeyId() The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.
String	getSnapshotArn() The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
Map<String,String>	getTags() The tags to be assigned to the elastic cluster snapshot.
String	getTargetSnapshotName() The identifier of the new elastic cluster snapshot to create from the source cluster snapshot.
int	hashCode()
Boolean	isCopyTags() Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot.
void	setCopyTags(Boolean copyTags) Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot.
void	setKmsKeyId(String kmsKeyId) The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.
void	setSnapshotArn(String snapshotArn) The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
void	setTags(Map<String,String> tags) The tags to be assigned to the elastic cluster snapshot.
void	setTargetSnapshotName(String targetSnapshotName) The identifier of the new elastic cluster snapshot to create from the source cluster snapshot.
String	toString() Returns a string representation of this object.
CopyClusterSnapshotRequest	withCopyTags(Boolean copyTags) Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot.
CopyClusterSnapshotRequest	withKmsKeyId(String kmsKeyId) The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.
CopyClusterSnapshotRequest	withSnapshotArn(String snapshotArn) The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
CopyClusterSnapshotRequest	withTags(Map<String,String> tags) The tags to be assigned to the elastic cluster snapshot.
CopyClusterSnapshotRequest	withTargetSnapshotName(String targetSnapshotName) The identifier of the new elastic cluster snapshot to create from the source cluster snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

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

Constructor Detail

CopyClusterSnapshotRequest

public CopyClusterSnapshotRequest()

Method Detail

setCopyTags

public void setCopyTags(Boolean copyTags)

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

Parameters:

copyTags - Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

getCopyTags

public Boolean getCopyTags()

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

Returns:

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

withCopyTags

public CopyClusterSnapshotRequest withCopyTags(Boolean copyTags)

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

Parameters:

copyTags - Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

Returns:

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

isCopyTags

public Boolean isCopyTags()

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

Returns:

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

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

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Parameters:

kmsKeyId - The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

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

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

getKmsKeyId

public String getKmsKeyId()

The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

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

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Returns:

The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

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

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

withKmsKeyId

public CopyClusterSnapshotRequest withKmsKeyId(String kmsKeyId)

The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

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

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Parameters:

kmsKeyId - The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

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

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Returns:

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

setSnapshotArn

public void setSnapshotArn(String snapshotArn)

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

Parameters:

snapshotArn - The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

getSnapshotArn

public String getSnapshotArn()

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

Returns:

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

withSnapshotArn

public CopyClusterSnapshotRequest withSnapshotArn(String snapshotArn)

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

Parameters:

snapshotArn - The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

Returns:

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

getTags

public Map<String,String> getTags()

The tags to be assigned to the elastic cluster snapshot.

Returns:

The tags to be assigned to the elastic cluster snapshot.

setTags

public void setTags(Map<String,String> tags)

The tags to be assigned to the elastic cluster snapshot.

Parameters:

tags - The tags to be assigned to the elastic cluster snapshot.

withTags

public CopyClusterSnapshotRequest withTags(Map<String,String> tags)

The tags to be assigned to the elastic cluster snapshot.

Parameters:

tags - The tags to be assigned to the elastic cluster snapshot.

Returns:

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

addTagsEntry

public CopyClusterSnapshotRequest addTagsEntry(String key,
                                               String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CopyClusterSnapshotRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setTargetSnapshotName

public void setTargetSnapshotName(String targetSnapshotName)

The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

Parameters:

targetSnapshotName - The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

getTargetSnapshotName

public String getTargetSnapshotName()

The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

Returns:

The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

withTargetSnapshotName

public CopyClusterSnapshotRequest withTargetSnapshotName(String targetSnapshotName)

The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

Parameters:

targetSnapshotName - The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

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 CopyClusterSnapshotRequest clone()

Overrides:

clone in class AmazonWebServiceRequest