com.amazonaws.services.elasticache.model.CopySnapshotRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights
* Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticache.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of a CopySnapshotMessage action.
*
*/
public class CopySnapshotRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable {
/**
*
* The name of an existing snapshot from which to make a copy.
*
*/
private String sourceSnapshotName;
/**
*
* 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.
*
*
*
*/
private String targetSnapshotName;
/**
*
* 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.
*
*/
private String targetBucket;
/**
*
* The name of an existing snapshot from which to make a copy.
*
*
* @param sourceSnapshotName
* The name of an existing snapshot from which to make a copy.
*/
public void setSourceSnapshotName(String sourceSnapshotName) {
this.sourceSnapshotName = sourceSnapshotName;
}
/**
*
* The name of an existing snapshot from which to make a copy.
*
*
* @return The name of an existing snapshot from which to make a copy.
*/
public String getSourceSnapshotName() {
return this.sourceSnapshotName;
}
/**
*
* The name of an existing snapshot from which to make a copy.
*
*
* @param sourceSnapshotName
* The name of an existing snapshot from which to make a copy.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CopySnapshotRequest withSourceSnapshotName(String sourceSnapshotName) {
setSourceSnapshotName(sourceSnapshotName);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setTargetSnapshotName(String targetSnapshotName) {
this.targetSnapshotName = 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.
*
*
*
*
* @return 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.
*
*
*/
public String getTargetSnapshotName() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CopySnapshotRequest withTargetSnapshotName(String targetSnapshotName) {
setTargetSnapshotName(targetSnapshotName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setTargetBucket(String targetBucket) {
this.targetBucket = 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.
*
*
* @return 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.
*/
public String getTargetBucket() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CopySnapshotRequest withTargetBucket(String targetBucket) {
setTargetBucket(targetBucket);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSourceSnapshotName() != null)
sb.append("SourceSnapshotName: " + getSourceSnapshotName() + ",");
if (getTargetSnapshotName() != null)
sb.append("TargetSnapshotName: " + getTargetSnapshotName() + ",");
if (getTargetBucket() != null)
sb.append("TargetBucket: " + getTargetBucket());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CopySnapshotRequest == false)
return false;
CopySnapshotRequest other = (CopySnapshotRequest) obj;
if (other.getSourceSnapshotName() == null
^ this.getSourceSnapshotName() == null)
return false;
if (other.getSourceSnapshotName() != null
&& other.getSourceSnapshotName().equals(
this.getSourceSnapshotName()) == false)
return false;
if (other.getTargetSnapshotName() == null
^ this.getTargetSnapshotName() == null)
return false;
if (other.getTargetSnapshotName() != null
&& other.getTargetSnapshotName().equals(
this.getTargetSnapshotName()) == false)
return false;
if (other.getTargetBucket() == null ^ this.getTargetBucket() == null)
return false;
if (other.getTargetBucket() != null
&& other.getTargetBucket().equals(this.getTargetBucket()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getSourceSnapshotName() == null) ? 0
: getSourceSnapshotName().hashCode());
hashCode = prime
* hashCode
+ ((getTargetSnapshotName() == null) ? 0
: getTargetSnapshotName().hashCode());
hashCode = prime
* hashCode
+ ((getTargetBucket() == null) ? 0 : getTargetBucket()
.hashCode());
return hashCode;
}
@Override
public CopySnapshotRequest clone() {
return (CopySnapshotRequest) super.clone();
}
}