com.amazonaws.services.elasticache.model

Class CopySnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.CopySnapshotRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CopySnapshotRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a CopySnapshotMessage action.

See Also:

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()
boolean	equals(Object obj)
String	getSourceSnapshotName() The name of an existing snapshot from which to make a copy.
String	getTargetBucket() The Amazon S3 bucket to which the snapshot will be exported.
String	getTargetSnapshotName() A name for the snapshot copy.
int	hashCode()
void	setSourceSnapshotName(String sourceSnapshotName) The name of an existing snapshot from which to make a copy.
void	setTargetBucket(String targetBucket) The Amazon S3 bucket to which the snapshot will be exported.
void	setTargetSnapshotName(String targetSnapshotName) A name for the snapshot copy.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CopySnapshotRequest	withSourceSnapshotName(String sourceSnapshotName) The name of an existing snapshot from which to make a copy.
CopySnapshotRequest	withTargetBucket(String targetBucket) The Amazon S3 bucket to which the snapshot will be exported.
CopySnapshotRequest	withTargetSnapshotName(String targetSnapshotName) A name for the snapshot copy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Error Message

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

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.

Error Message

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

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.

Error Message

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

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.

Error Message

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

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.

Error Message

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

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.

Error Message

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

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

Error Messages:

You could receive one of the following error messages.

Erorr Messages

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions permissions on the bucket.

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

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

Parameters:

targetBucket - The Amazon S3 bucket to which the snapshot will be 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.

Error Messages:

You could receive one of the following error messages.

Erorr Messages

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions permissions on the bucket.

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

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

Error Messages:

You could receive one of the following error messages.

Erorr Messages

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions permissions on the bucket.

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

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

Returns:

The Amazon S3 bucket to which the snapshot will be 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.

Error Messages:

You could receive one of the following error messages.

Erorr Messages

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions permissions on the bucket.

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

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

Error Messages:

You could receive one of the following error messages.

Erorr Messages

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions permissions on the bucket.

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

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

Parameters:

targetBucket - The Amazon S3 bucket to which the snapshot will be 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.

Error Messages:

You could receive one of the following error messages.

Erorr Messages

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions permissions on the bucket.

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

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.

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

Overrides:

clone in class AmazonWebServiceRequest