java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.CopyImageRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CopyImageRequest
extends Ec2Request
implements ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>

Contains the parameters for CopyImage.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CopyImageRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CopyImageRequest.Builder`	`builder()`
`String`	`clientToken()`	Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`Boolean`	`copyImageTags()`	Specifies whether to copy your user-defined AMI tags to the new AMI.
`String`	`description()`	A description for the new AMI.
`String`	`destinationAvailabilityZone()`	The Local Zone for the new AMI (for example, `cn-north-1-pkx-1a`).
`String`	`destinationAvailabilityZoneId()`	The ID of the Local Zone for the new AMI (for example, `cnn1-pkx1-az1`).
`String`	`destinationOutpostArn()`	The Amazon Resource Name (ARN) of the Outpost for the new AMI.
`Boolean`	`dryRun()`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`Boolean`	`encrypted()`	Specifies whether to encrypt the snapshots of the copied image.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagSpecifications()`	For responses, this returns true if the service returned a value for the TagSpecifications property.
`String`	`kmsKeyId()`	The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes.
`String`	`name()`	The name of the new AMI.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CopyImageRequest.Builder>`	`serializableBuilderClass()`
`Long`	`snapshotCopyCompletionDurationMinutes()`	Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy.
`String`	`sourceImageId()`	The ID of the AMI to copy.
`String`	`sourceRegion()`	The name of the Region that contains the AMI to copy.
`List<TagSpecification>`	`tagSpecifications()`	The tags to apply to the new AMI and new snapshots.
`CopyImageRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientToken
```
public final String clientToken()
```
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in Amazon EC2 API requests 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 Amazon EC2 API requests in the Amazon EC2 API Reference.
  - description
```
public final String description()
```
    A description for the new AMI.
    
    Returns:
    
    A description for the new AMI.
  - encrypted
```
public final Boolean encrypted()
```
    Specifies whether to encrypt the snapshots of the copied image.
    
    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 Use encryption with EBS-backed AMIs in the Amazon EC2 User Guide.
    
    Returns:
    
    Specifies whether to encrypt the snapshots of the copied image.
    
    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 Use encryption with EBS-backed AMIs in the Amazon EC2 User Guide.
  - kmsKeyId
```
public final 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.
    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.
  - name
```
public final String name()
```
    The name of the new AMI.
    
    Returns:
    
    The name of the new AMI.
  - sourceImageId
```
public final String sourceImageId()
```
    The ID of the AMI to copy.
    
    Returns:
    
    The ID of the AMI to copy.
  - sourceRegion
```
public final String sourceRegion()
```
    The name of the Region that contains the AMI to copy.
    
    Returns:
    
    The name of the Region that contains the AMI to copy.
  - destinationOutpostArn
```
public final String destinationOutpostArn()
```
    The Amazon Resource Name (ARN) of the Outpost for the new 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 can't 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.
    
    Only one of DestinationAvailabilityZone, DestinationAvailabilityZoneId, or DestinationOutpostArn can be specified.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Outpost for the new 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 can't 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.
    
    Only one of DestinationAvailabilityZone, DestinationAvailabilityZoneId, or DestinationOutpostArn can be specified.
  - copyImageTags
```
public final Boolean copyImageTags()
```
    Specifies whether to copy your user-defined AMI tags to the new AMI.
    
    The following tags are 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:
    
    Specifies whether to copy your user-defined AMI tags to the new AMI.
    
    The following tags are 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.
  - hasTagSpecifications
```
public final boolean hasTagSpecifications()
```
    For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagSpecifications
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.
    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.
  - snapshotCopyCompletionDurationMinutes
```
public final Long snapshotCopyCompletionDurationMinutes()
```
    Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target.
    
    If you do not specify a value, the AMI copy operation is completed on a best-effort basis.
    
    This parameter is not supported when copying an AMI to or from a Local Zone, or to an Outpost.
    
    For more information, see Time-based copies for Amazon EBS snapshots and EBS-backed AMIs.
    
    Returns:
    
    Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target.
    
    If you do not specify a value, the AMI copy operation is completed on a best-effort basis.
    
    This parameter is not supported when copying an AMI to or from a Local Zone, or to an Outpost.
    
    For more information, see Time-based copies for Amazon EBS snapshots and EBS-backed AMIs.
  - destinationAvailabilityZone
```
public final String destinationAvailabilityZone()
```
    The Local Zone for the new AMI (for example, cn-north-1-pkx-1a).
    
    Only one of DestinationAvailabilityZone, DestinationAvailabilityZoneId, or DestinationOutpostArn can be specified.
    
    Returns:
    
    The Local Zone for the new AMI (for example, cn-north-1-pkx-1a).
    
    Only one of DestinationAvailabilityZone, DestinationAvailabilityZoneId, or DestinationOutpostArn can be specified.
  - destinationAvailabilityZoneId
```
public final String destinationAvailabilityZoneId()
```
    The ID of the Local Zone for the new AMI (for example, cnn1-pkx1-az1).
    
    Only one of DestinationAvailabilityZone, DestinationAvailabilityZoneId, or DestinationOutpostArn can be specified.
    
    Returns:
    
    The ID of the Local Zone for the new AMI (for example, cnn1-pkx1-az1).
    
    Only one of DestinationAvailabilityZone, DestinationAvailabilityZoneId, or DestinationOutpostArn can be specified.
  - dryRun
```
public final Boolean dryRun()
```
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    
    Returns:
    
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - toBuilder
```
public CopyImageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CopyImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CopyImageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CopyImageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientToken

description

encrypted

kmsKeyId

name

sourceImageId

sourceRegion

destinationOutpostArn

copyImageTags

hasTagSpecifications

tagSpecifications

snapshotCopyCompletionDurationMinutes

destinationAvailabilityZone

destinationAvailabilityZoneId

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField