CopyImageRequest (AWS SDK for Java

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(value="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 and Description

static interface CopyImageRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CopyImageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CopyImageRequest.Builder`	`builder()`
`String`	`clientToken()` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`String`	`description()` A description for the new AMI in the destination region.
`Boolean`	`encrypted()` Specifies whether the destination snapshots of the copied image should be encrypted.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`kmsKeyId()` An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume.
`String`	`name()` The name of the new AMI in the destination region.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CopyImageRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceImageId()` The ID of the AMI to copy.
`String`	`sourceRegion()` The name of the region that contains the AMI to copy.
`CopyImageRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

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

- Method Detail
  - clientToken
```
public 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:
    
    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.
  - description
```
public String description()
```
    A description for the new AMI in the destination region.
    
    Returns:
    
    A description for the new AMI in the destination region.
  - encrypted
```
public 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 CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using 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. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
  - kmsKeyId
```
public String kmsKeyId()
```
    An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. 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. If a KmsKeyId is specified, the Encrypted flag must also be set.
    
    The CMK identifier may be provided in any of the following formats:
    - Key ID
    - Key alias, in the form alias/ExampleAlias
    - ARN using key ID. The ID 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.
    - ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
    AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
    
    The specified CMK must exist in the region that the snapshot is being copied to.
    Returns:
    An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. 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. If a KmsKeyId is specified, the Encrypted flag must also be set.
    
    The CMK identifier may be provided in any of the following formats:
    
    Key ID
    
    Key alias, in the form alias/ExampleAlias
    
    ARN using key ID. The ID 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.
    
    ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
    
    AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
    
    The specified CMK must exist in the region that the snapshot is being copied to.
  - name
```
public String name()
```
    The name of the new AMI in the destination region.
    
    Returns:
    
    The name of the new AMI in the destination region.
  - sourceImageId
```
public String sourceImageId()
```
    The ID of the AMI to copy.
    
    Returns:
    
    The ID of the AMI to copy.
  - sourceRegion
```
public 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.
  - toBuilder
```
public CopyImageRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static CopyImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CopyImageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields