com.amazonaws.services.elasticache.model

Class CopySnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.CopySnapshotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents the input of a CopySnapshotMessage operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CopySnapshotRequest()

Method Summary

Modifier and Type	Method and Description
CopySnapshotRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getKmsKeyId() The ID of the KMS key used to encrypt the target snapshot.
String	getSourceSnapshotName() The name of an existing snapshot from which to make a copy.
List<Tag>	getTags() A list of tags to be added to this resource.
String	getTargetBucket() The Amazon S3 bucket to which the snapshot is exported.
String	getTargetSnapshotName() A name for the snapshot copy.
int	hashCode()
void	setKmsKeyId(String kmsKeyId) The ID of the KMS key used to encrypt the target snapshot.
void	setSourceSnapshotName(String sourceSnapshotName) The name of an existing snapshot from which to make a copy.
void	setTags(Collection<Tag> tags) A list of tags to be added to this resource.
void	setTargetBucket(String targetBucket) The Amazon S3 bucket to which the snapshot is exported.
void	setTargetSnapshotName(String targetSnapshotName) A name for the snapshot copy.
String	toString() Returns a string representation of this object.
CopySnapshotRequest	withKmsKeyId(String kmsKeyId) The ID of the KMS key used to encrypt the target snapshot.
CopySnapshotRequest	withSourceSnapshotName(String sourceSnapshotName) The name of an existing snapshot from which to make a copy.
CopySnapshotRequest	withTags(Collection<Tag> tags) A list of tags to be added to this resource.
CopySnapshotRequest	withTags(Tag... tags) A list of tags to be added to this resource.
CopySnapshotRequest	withTargetBucket(String targetBucket) The Amazon S3 bucket to which the snapshot is exported.
CopySnapshotRequest	withTargetSnapshotName(String targetSnapshotName) A name for the snapshot copy.

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

CopySnapshotRequest

public CopySnapshotRequest()

Method Detail

setSourceSnapshotName

public void setSourceSnapshotName(String sourceSnapshotName)

The name of an existing snapshot from which to make a copy.

Parameters:

sourceSnapshotName - The name of an existing snapshot from which to make a copy.

getSourceSnapshotName

public String getSourceSnapshotName()

The name of an existing snapshot from which to make a copy.

Returns:

The name of an existing snapshot from which to make a copy.

withSourceSnapshotName

public CopySnapshotRequest withSourceSnapshotName(String sourceSnapshotName)

The name of an existing snapshot from which to make a copy.

Parameters:

sourceSnapshotName - The name of an existing snapshot from which to make a copy.

Returns:

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

setTargetSnapshotName

public void setTargetSnapshotName(String targetSnapshotName)

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Parameters:

targetSnapshotName - A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

getTargetSnapshotName

public String getTargetSnapshotName()

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Returns:

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

withTargetSnapshotName

public CopySnapshotRequest withTargetSnapshotName(String targetSnapshotName)

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Parameters:

targetSnapshotName - A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Returns:

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

setTargetBucket

public void setTargetBucket(String targetBucket)

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Parameters:

targetBucket - The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

getTargetBucket

public String getTargetBucket()

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Returns:

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

withTargetBucket

public CopySnapshotRequest withTargetBucket(String targetBucket)

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Parameters:

targetBucket - The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The ID of the KMS key used to encrypt the target snapshot.

Parameters:

kmsKeyId - The ID of the KMS key used to encrypt the target snapshot.

getKmsKeyId

public String getKmsKeyId()

The ID of the KMS key used to encrypt the target snapshot.

Returns:

The ID of the KMS key used to encrypt the target snapshot.

withKmsKeyId

public CopySnapshotRequest withKmsKeyId(String kmsKeyId)

The ID of the KMS key used to encrypt the target snapshot.

Parameters:

kmsKeyId - The ID of the KMS key used to encrypt the target snapshot.

Returns:

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

getTags

public List<Tag> getTags()

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

setTags

public void setTags(Collection<Tag> tags)

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Parameters:

tags - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

withTags

public CopySnapshotRequest withTags(Tag... tags)

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

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 - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

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

withTags

public CopySnapshotRequest withTags(Collection<Tag> tags)

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Parameters:

tags - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

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