@Generated(value="software.amazon.awssdk:codegen") public class CopyImageRequest extends EC2Request implements ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>
Contains the parameters for CopyImage.
Modifier and Type | Class and Description |
---|---|
static interface |
CopyImageRequest.Builder |
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()
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.
|
String |
name()
The name of the new AMI in the destination region.
|
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() |
requestOverrideConfig
copy
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.
public String description()
A description for the new AMI in the destination region.
public 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.
KmsKeyId
. For more information, see Amazon EBS Encryption in
the Amazon Elastic Compute Cloud User Guide.public 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.
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.public String name()
The name of the new AMI in the destination region.
public String sourceImageId()
The ID of the AMI to copy.
public String sourceRegion()
The name of the region that contains the AMI to copy.
public CopyImageRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CopyImageRequest.Builder,CopyImageRequest>
toBuilder
in class EC2Request
public static CopyImageRequest.Builder builder()
public static Class<? extends CopyImageRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.