com.amazonaws.services.ec2.model

Class CopySnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CopySnapshotRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<CopySnapshotRequest>, Serializable, Cloneable

public class CopySnapshotRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CopySnapshotRequest>

Container for the parameters to the CopySnapshot operation.

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.

NOTE: Copying snapshots that were encrypted with non-default AWS Key Management Service (KMS) master keys is not supported at this time.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux .

See Also:

AmazonEC2.copySnapshot(CopySnapshotRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CopySnapshotRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CopySnapshotRequest	clone()
boolean	equals(Object obj)
String	getDescription() A description for the EBS snapshot.
String	getDestinationRegion() The destination region to use in the PresignedUrl parameter of a snapshot copy operation.
Request<CopySnapshotRequest>	getDryRunRequest() This method is intended for internal use only.
String	getPresignedUrl() The pre-signed URL that facilitates copying an encrypted snapshot.
String	getSourceRegion() The ID of the region that contains the snapshot to be copied.
String	getSourceSnapshotId() The ID of the EBS snapshot to copy.
int	hashCode()
void	setDescription(String description) A description for the EBS snapshot.
void	setDestinationRegion(String destinationRegion) The destination region to use in the PresignedUrl parameter of a snapshot copy operation.
void	setPresignedUrl(String presignedUrl) The pre-signed URL that facilitates copying an encrypted snapshot.
void	setSourceRegion(String sourceRegion) The ID of the region that contains the snapshot to be copied.
void	setSourceSnapshotId(String sourceSnapshotId) The ID of the EBS snapshot to copy.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CopySnapshotRequest	withDescription(String description) A description for the EBS snapshot.
CopySnapshotRequest	withDestinationRegion(String destinationRegion) The destination region to use in the PresignedUrl parameter of a snapshot copy operation.
CopySnapshotRequest	withPresignedUrl(String presignedUrl) The pre-signed URL that facilitates copying an encrypted snapshot.
CopySnapshotRequest	withSourceRegion(String sourceRegion) The ID of the region that contains the snapshot to be copied.
CopySnapshotRequest	withSourceSnapshotId(String sourceSnapshotId) The ID of the EBS snapshot to copy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CopySnapshotRequest

public CopySnapshotRequest()

Method Detail

getSourceRegion

public String getSourceRegion()

The ID of the region that contains the snapshot to be copied.

Returns:

The ID of the region that contains the snapshot to be copied.

setSourceRegion

public void setSourceRegion(String sourceRegion)

The ID of the region that contains the snapshot to be copied.

Parameters:

sourceRegion - The ID of the region that contains the snapshot to be copied.

withSourceRegion

public CopySnapshotRequest withSourceRegion(String sourceRegion)

The ID of the region that contains the snapshot to be copied.

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

Parameters:

sourceRegion - The ID of the region that contains the snapshot to be copied.

Returns:

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

getSourceSnapshotId

public String getSourceSnapshotId()

The ID of the EBS snapshot to copy.

Returns:

The ID of the EBS snapshot to copy.

setSourceSnapshotId

public void setSourceSnapshotId(String sourceSnapshotId)

The ID of the EBS snapshot to copy.

Parameters:

sourceSnapshotId - The ID of the EBS snapshot to copy.

withSourceSnapshotId

public CopySnapshotRequest withSourceSnapshotId(String sourceSnapshotId)

The ID of the EBS snapshot to copy.

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

Parameters:

sourceSnapshotId - The ID of the EBS snapshot to copy.

Returns:

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

getDescription

public String getDescription()

A description for the EBS snapshot.

Returns:

A description for the EBS snapshot.

setDescription

public void setDescription(String description)

A description for the EBS snapshot.

Parameters:

description - A description for the EBS snapshot.

withDescription

public CopySnapshotRequest withDescription(String description)

A description for the EBS snapshot.

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

Parameters:

description - A description for the EBS snapshot.

Returns:

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

getDestinationRegion

public String getDestinationRegion()

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

Returns:

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

setDestinationRegion

public void setDestinationRegion(String destinationRegion)

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

Parameters:

destinationRegion - The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

withDestinationRegion

public CopySnapshotRequest withDestinationRegion(String destinationRegion)

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

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

Parameters:

destinationRegion - The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

Returns:

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

getPresignedUrl

public String getPresignedUrl()

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Returns:

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

setPresignedUrl

public void setPresignedUrl(String presignedUrl)

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Parameters:

presignedUrl - The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

withPresignedUrl

public CopySnapshotRequest withPresignedUrl(String presignedUrl)

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

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

Parameters:

presignedUrl - The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Returns:

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

getDryRunRequest

public Request<CopySnapshotRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CopySnapshotRequest>

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

Overrides:

clone in class AmazonWebServiceRequest