CopySnapshotRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.CopySnapshotRequest

All Implemented Interfaces:

DryRunSupportedRequest<CopySnapshotRequest>, java.io.Serializable, java.lang.Cloneable
```
public class CopySnapshotRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, 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, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

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

See Also:

AmazonEC2.copySnapshot(CopySnapshotRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

CopySnapshotRequest()

Constructors
Constructor and Description
`CopySnapshotRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDescription()` A description for the EBS snapshot.
`java.lang.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.
`java.lang.Boolean`	`getEncrypted()` Specifies whether the destination snapshot should be encrypted.
`java.lang.String`	`getKmsKeyId()` The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.
`java.lang.String`	`getPresignedUrl()` The pre-signed URL that facilitates copying an encrypted snapshot.
`java.lang.String`	`getSourceRegion()` The ID of the region that contains the snapshot to be copied.
`java.lang.String`	`getSourceSnapshotId()` The ID of the EBS snapshot to copy.
`int`	`hashCode()`
`java.lang.Boolean`	`isEncrypted()` Specifies whether the destination snapshot should be encrypted.
`void`	`setDescription(java.lang.String description)` A description for the EBS snapshot.
`void`	`setDestinationRegion(java.lang.String destinationRegion)` The destination region to use in the `PresignedUrl` parameter of a snapshot copy operation.
`void`	`setEncrypted(java.lang.Boolean encrypted)` Specifies whether the destination snapshot should be encrypted.
`void`	`setKmsKeyId(java.lang.String kmsKeyId)` The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.
`void`	`setPresignedUrl(java.lang.String presignedUrl)` The pre-signed URL that facilitates copying an encrypted snapshot.
`void`	`setSourceRegion(java.lang.String sourceRegion)` The ID of the region that contains the snapshot to be copied.
`void`	`setSourceSnapshotId(java.lang.String sourceSnapshotId)` The ID of the EBS snapshot to copy.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CopySnapshotRequest`	`withDescription(java.lang.String description)` A description for the EBS snapshot.
`CopySnapshotRequest`	`withDestinationRegion(java.lang.String destinationRegion)` The destination region to use in the `PresignedUrl` parameter of a snapshot copy operation.
`CopySnapshotRequest`	`withEncrypted(java.lang.Boolean encrypted)` Specifies whether the destination snapshot should be encrypted.
`CopySnapshotRequest`	`withKmsKeyId(java.lang.String kmsKeyId)` The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.
`CopySnapshotRequest`	`withPresignedUrl(java.lang.String presignedUrl)` The pre-signed URL that facilitates copying an encrypted snapshot.
`CopySnapshotRequest`	`withSourceRegion(java.lang.String sourceRegion)` The ID of the region that contains the snapshot to be copied.
`CopySnapshotRequest`	`withSourceSnapshotId(java.lang.String sourceSnapshotId)` The ID of the EBS snapshot to copy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CopySnapshotRequest
```
public CopySnapshotRequest()
```
- Method Detail
  - getSourceRegion
```
public java.lang.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(java.lang.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(java.lang.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 java.lang.String getSourceSnapshotId()
```
    The ID of the EBS snapshot to copy.
    
    Returns:
    
    The ID of the EBS snapshot to copy.
  - setSourceSnapshotId
```
public void setSourceSnapshotId(java.lang.String sourceSnapshotId)
```
    The ID of the EBS snapshot to copy.
    
    Parameters:
    
    sourceSnapshotId - The ID of the EBS snapshot to copy.
  - withSourceSnapshotId
```
public CopySnapshotRequest withSourceSnapshotId(java.lang.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 java.lang.String getDescription()
```
    A description for the EBS snapshot.
    
    Returns:
    
    A description for the EBS snapshot.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    A description for the EBS snapshot.
    
    Parameters:
    
    description - A description for the EBS snapshot.
  - withDescription
```
public CopySnapshotRequest withDescription(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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.
  - isEncrypted
```
public java.lang.Boolean isEncrypted()
```
    Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
  - setEncrypted
```
public void setEncrypted(java.lang.Boolean encrypted)
```
    Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    encrypted - Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
  - withEncrypted
```
public CopySnapshotRequest withEncrypted(java.lang.Boolean encrypted)
```
    Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    encrypted - Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEncrypted
```
public java.lang.Boolean getEncrypted()
```
    Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
  - getKmsKeyId
```
public java.lang.String getKmsKeyId()
```
    The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
    
    Returns:
    
    The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
  - setKmsKeyId
```
public void setKmsKeyId(java.lang.String kmsKeyId)
```
    The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
    
    Parameters:
    
    kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
  - withKmsKeyId
```
public CopySnapshotRequest withKmsKeyId(java.lang.String kmsKeyId)
```
    The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
    
    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 java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class CopySnapshotRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CopySnapshotRequest

Method Detail

getSourceRegion

setSourceRegion

withSourceRegion

getSourceSnapshotId

setSourceSnapshotId

withSourceSnapshotId

getDescription

setDescription

withDescription

getDestinationRegion

setDestinationRegion

withDestinationRegion

getPresignedUrl

setPresignedUrl

withPresignedUrl

isEncrypted

setEncrypted

withEncrypted

getEncrypted

getKmsKeyId

setKmsKeyId

withKmsKeyId

getDryRunRequest

toString

hashCode

equals