com.amazonaws.services.ec2.model

Class CopyImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CopyImageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CopyImageRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CopyImageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CopyImageRequest>

Contains the parameters for CopyImage.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CopyImageRequest()

Method Summary

Modifier and Type	Method and Description
CopyImageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
Boolean	getCopyImageTags() Indicates whether to include your user-defined AMI tags when copying the AMI.
String	getDescription() A description for the new AMI in the destination Region.
String	getDestinationOutpostArn() The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI.
Request<CopyImageRequest>	getDryRunRequest() This method is intended for internal use only.
Boolean	getEncrypted() Specifies whether the destination snapshots of the copied image should be encrypted.
String	getKmsKeyId() The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes.
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.
List<TagSpecification>	getTagSpecifications() The tags to apply to the new AMI and new snapshots.
int	hashCode()
Boolean	isCopyImageTags() Indicates whether to include your user-defined AMI tags when copying the AMI.
Boolean	isEncrypted() Specifies whether the destination snapshots of the copied image should be encrypted.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
void	setCopyImageTags(Boolean copyImageTags) Indicates whether to include your user-defined AMI tags when copying the AMI.
void	setDescription(String description) A description for the new AMI in the destination Region.
void	setDestinationOutpostArn(String destinationOutpostArn) The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI.
void	setEncrypted(Boolean encrypted) Specifies whether the destination snapshots of the copied image should be encrypted.
void	setKmsKeyId(String kmsKeyId) The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes.
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.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the new AMI and new snapshots.
String	toString() Returns a string representation of this object.
CopyImageRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
CopyImageRequest	withCopyImageTags(Boolean copyImageTags) Indicates whether to include your user-defined AMI tags when copying the AMI.
CopyImageRequest	withDescription(String description) A description for the new AMI in the destination Region.
CopyImageRequest	withDestinationOutpostArn(String destinationOutpostArn) The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI.
CopyImageRequest	withEncrypted(Boolean encrypted) Specifies whether the destination snapshots of the copied image should be encrypted.
CopyImageRequest	withKmsKeyId(String kmsKeyId) The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes.
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.
CopyImageRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the new AMI and new snapshots.
CopyImageRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the new AMI and new snapshots.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CopyImageRequest

public CopyImageRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Returns:

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

withClientToken

public CopyImageRequest withClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Returns:

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

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.

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.

withDescription

public CopyImageRequest withDescription(String description)

A description for the new AMI in the destination Region.

Parameters:

description - A description for the new AMI in the destination Region.

Returns:

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

setEncrypted

public void setEncrypted(Boolean encrypted)

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

Parameters:

encrypted - Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

getEncrypted

public Boolean getEncrypted()

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

Returns:

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

withEncrypted

public CopyImageRequest withEncrypted(Boolean encrypted)

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

Parameters:

encrypted - Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

Returns:

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

isEncrypted

public Boolean isEncrypted()

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

Returns:

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

You can specify a KMS key using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

Parameters:

kmsKeyId - The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

You can specify a KMS key using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

getKmsKeyId

public String getKmsKeyId()

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

You can specify a KMS key using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

Returns:

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

You can specify a KMS key using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

withKmsKeyId

public CopyImageRequest withKmsKeyId(String kmsKeyId)

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

You can specify a KMS key using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

Parameters:

kmsKeyId - The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

You can specify a KMS key using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

Returns:

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

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.

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.

withName

public CopyImageRequest withName(String name)

The name of the new AMI in the destination Region.

Parameters:

name - The name of the new AMI in the destination Region.

Returns:

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

setSourceImageId

public void setSourceImageId(String sourceImageId)

The ID of the AMI to copy.

Parameters:

sourceImageId - The ID of the AMI to copy.

getSourceImageId

public String getSourceImageId()

The ID of the AMI to copy.

Returns:

The ID of the AMI to copy.

withSourceImageId

public CopyImageRequest withSourceImageId(String sourceImageId)

The ID of the AMI to copy.

Parameters:

sourceImageId - The ID of the AMI to copy.

Returns:

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

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.

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.

withSourceRegion

public CopyImageRequest withSourceRegion(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.

Returns:

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

setDestinationOutpostArn

public void setDestinationOutpostArn(String destinationOutpostArn)

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

Parameters:

destinationOutpostArn - The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

getDestinationOutpostArn

public String getDestinationOutpostArn()

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

Returns:

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

withDestinationOutpostArn

public CopyImageRequest withDestinationOutpostArn(String destinationOutpostArn)

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

Parameters:

destinationOutpostArn - The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

Returns:

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

setCopyImageTags

public void setCopyImageTags(Boolean copyImageTags)

Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

Parameters:

copyImageTags - Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

getCopyImageTags

public Boolean getCopyImageTags()

Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

Returns:

Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

withCopyImageTags

public CopyImageRequest withCopyImageTags(Boolean copyImageTags)

Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

Parameters:

copyImageTags - Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

Returns:

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

isCopyImageTags

public Boolean isCopyImageTags()

Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

Returns:

Indicates whether to include your user-defined AMI tags when copying the AMI.

The following tags will not be copied:

• System tags (prefixed with aws:)

• For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

Default: Your user-defined AMI tags are not copied.

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

Returns:

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

Parameters:

tagSpecifications - The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

withTagSpecifications

public CopyImageRequest withTagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

Returns:

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

withTagSpecifications

public CopyImageRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

Parameters:

tagSpecifications - The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

• To tag the new AMI, the value for ResourceType must be image.

• To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

Returns:

Returns a reference to this 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CopyImageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()