CopyImageRequest (AWS SDK For Java for OSGi 1.10.1 API)

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

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<CopyImageRequest>, Serializable, Cloneable
```
public class CopyImageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, 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. AMIs that use encrypted EBS snapshots cannot be copied with this method.

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

See Also:
AmazonEC2.copyImage(CopyImageRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CopyImageRequest()

Constructors
Constructor and Description
`CopyImageRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`CopyImageRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`String`	`getDescription()` A description for the new AMI in the destination region.
`Request<CopyImageRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`String`	`getName()` The name of the new AMI in the destination region.
`String`	`getSourceImageId()` The ID of the AMI to copy.
`String`	`getSourceRegion()` The name of the region that contains the AMI to copy.
`int`	`hashCode()`
`void`	`setClientToken(String clientToken)` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`void`	`setDescription(String description)` A description for the new AMI in the destination region.
`void`	`setName(String name)` The name of the new AMI in the destination region.
`void`	`setSourceImageId(String sourceImageId)` The ID of the AMI to copy.
`void`	`setSourceRegion(String sourceRegion)` The name of the region that contains the AMI to copy.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CopyImageRequest`	`withClientToken(String clientToken)` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`CopyImageRequest`	`withDescription(String description)` A description for the new AMI in the destination region.
`CopyImageRequest`	`withName(String name)` The name of the new AMI in the destination region.
`CopyImageRequest`	`withSourceImageId(String sourceImageId)` The ID of the AMI to copy.
`CopyImageRequest`	`withSourceRegion(String sourceRegion)` The name of the region that contains the AMI to copy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, 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
  - CopyImageRequest
```
public CopyImageRequest()
```
- Method Detail
  - getSourceRegion
```
public 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(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(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 String getSourceImageId()
```
    The ID of the AMI to copy.
    
    Returns:
    The ID of the AMI to copy.
  - setSourceImageId
```
public void setSourceImageId(String sourceImageId)
```
    The ID of the AMI to copy.
    
    Parameters:
    sourceImageId - The ID of the AMI to copy.
  - withSourceImageId
```
public CopyImageRequest withSourceImageId(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 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(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(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 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(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(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 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(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(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.
  - 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 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 CopyImageRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

Class CopyImageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

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

getDryRunRequest

toString

hashCode

equals

clone