CopyImageRequest (AWS SDK for Android

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

All Implemented Interfaces:

DryRunSupportedRequest<CopyImageRequest>, java.io.Serializable, java.lang.Cloneable
```
public class CopyImageRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<CopyImageRequest>
```
Container for the parameters to the CopyImage operation.
Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.copyImage(CopyImageRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

CopyImageRequest()

Constructors
Constructor and Description
`CopyImageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientToken()` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`java.lang.String`	`getDescription()` A description for the new AMI in the destination region.
`Request<CopyImageRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`java.lang.Boolean`	`getEncrypted()` Specifies whether the destination snapshots of the copied image should be encrypted.
`java.lang.String`	`getKmsKeyId()` The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation.
`java.lang.String`	`getName()` The name of the new AMI in the destination region.
`java.lang.String`	`getSourceImageId()` The ID of the AMI to copy.
`java.lang.String`	`getSourceRegion()` The name of the region that contains the AMI to copy.
`int`	`hashCode()`
`java.lang.Boolean`	`isEncrypted()` Specifies whether the destination snapshots of the copied image should be encrypted.
`void`	`setClientToken(java.lang.String clientToken)` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`void`	`setDescription(java.lang.String description)` A description for the new AMI in the destination region.
`void`	`setEncrypted(java.lang.Boolean encrypted)` Specifies whether the destination snapshots of the copied image should be encrypted.
`void`	`setKmsKeyId(java.lang.String kmsKeyId)` The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation.
`void`	`setName(java.lang.String name)` The name of the new AMI in the destination region.
`void`	`setSourceImageId(java.lang.String sourceImageId)` The ID of the AMI to copy.
`void`	`setSourceRegion(java.lang.String sourceRegion)` The name of the region that contains the AMI to copy.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CopyImageRequest`	`withClientToken(java.lang.String clientToken)` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`CopyImageRequest`	`withDescription(java.lang.String description)` A description for the new AMI in the destination region.
`CopyImageRequest`	`withEncrypted(java.lang.Boolean encrypted)` Specifies whether the destination snapshots of the copied image should be encrypted.
`CopyImageRequest`	`withKmsKeyId(java.lang.String kmsKeyId)` The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation.
`CopyImageRequest`	`withName(java.lang.String name)` The name of the new AMI in the destination region.
`CopyImageRequest`	`withSourceImageId(java.lang.String sourceImageId)` The ID of the AMI to copy.
`CopyImageRequest`	`withSourceRegion(java.lang.String sourceRegion)` The name of the region that contains the AMI 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
  - CopyImageRequest
```
public CopyImageRequest()
```
- Method Detail
  - getSourceRegion
```
public java.lang.String getSourceRegion()
```
    The name of the region that contains the AMI to copy.
    
    Returns:
    
    The name of the region that contains the AMI to copy.
  - setSourceRegion
```
public void setSourceRegion(java.lang.String sourceRegion)
```
    The name of the region that contains the AMI to copy.
    
    Parameters:
    
    sourceRegion - The name of the region that contains the AMI to copy.
  - withSourceRegion
```
public CopyImageRequest withSourceRegion(java.lang.String sourceRegion)
```
    The name of the region that contains the AMI to copy.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sourceRegion - The name of the region that contains the AMI to copy.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSourceImageId
```
public java.lang.String getSourceImageId()
```
    The ID of the AMI to copy.
    
    Returns:
    
    The ID of the AMI to copy.
  - setSourceImageId
```
public void setSourceImageId(java.lang.String sourceImageId)
```
    The ID of the AMI to copy.
    
    Parameters:
    
    sourceImageId - The ID of the AMI to copy.
  - withSourceImageId
```
public CopyImageRequest withSourceImageId(java.lang.String sourceImageId)
```
    The ID of the AMI to copy.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sourceImageId - The ID of the AMI to copy.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public java.lang.String getName()
```
    The name of the new AMI in the destination region.
    
    Returns:
    
    The name of the new AMI in the destination region.
  - setName
```
public void setName(java.lang.String name)
```
    The name of the new AMI in the destination region.
    
    Parameters:
    
    name - The name of the new AMI in the destination region.
  - withName
```
public CopyImageRequest withName(java.lang.String name)
```
    The name of the new AMI in the destination region.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    name - The name of the new AMI in the destination region.
    
    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 new AMI in the destination region.
    
    Returns:
    
    A description for the new AMI in the destination region.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    A description for the new AMI in the destination region.
    
    Parameters:
    
    description - A description for the new AMI in the destination region.
  - withDescription
```
public CopyImageRequest withDescription(java.lang.String description)
```
    A description for the new AMI in the destination region.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    description - A description for the new AMI in the destination region.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientToken
```
public java.lang.String getClientToken()
```
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
  - setClientToken
```
public void setClientToken(java.lang.String clientToken)
```
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
  - withClientToken
```
public CopyImageRequest withClientToken(java.lang.String clientToken)
```
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    
    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 snapshots of the copied image should be encrypted. 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 snapshots of the copied image should be encrypted. 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 snapshots of the copied image should be encrypted. 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 snapshots of the copied image should be encrypted. 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 CopyImageRequest withEncrypted(java.lang.Boolean encrypted)
```
    Specifies whether the destination snapshots of the copied image should be encrypted. 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 snapshots of the copied image should be encrypted. 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 snapshots of the copied image should be encrypted. 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 snapshots of the copied image should be encrypted. 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 encrypting the snapshots of an image during a copy operation. 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 encrypting the snapshots of an image during a copy operation. 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 encrypting the snapshots of an image during a copy operation. 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 encrypting the snapshots of an image during a copy operation. 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 CopyImageRequest withKmsKeyId(java.lang.String kmsKeyId)
```
    The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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 encrypting the snapshots of an image during a copy operation. 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<CopyImageRequest> 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<CopyImageRequest>
  - 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 CopyImageRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CopyImageRequest

Method Detail

getSourceRegion

setSourceRegion

withSourceRegion

getSourceImageId

setSourceImageId

withSourceImageId

getName

setName

withName

getDescription

setDescription

withDescription

getClientToken

setClientToken

withClientToken

isEncrypted

setEncrypted

withEncrypted

getEncrypted

getKmsKeyId

setKmsKeyId

withKmsKeyId

getDryRunRequest

toString

hashCode

equals