NAME
Paws::EC2::CopyImage - Arguments for method CopyImage on Paws::EC2
DESCRIPTION
This class represents the parameters used for calling the method CopyImage on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method CopyImage.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyImage.
SYNOPSIS
my $ec2 = Paws->service('EC2');
# To copy an AMI to another region
# This example copies the specified AMI from the us-east-1 region to the current
# region.
my $CopyImageResult = $ec2->CopyImage(
'Description' => '',
'Name' => 'My server',
'SourceImageId' => 'ami-5731123e',
'SourceRegion' => 'us-east-1'
);
# Results:
my $ImageId = $CopyImageResult->ImageId;
# Returns a L<Paws::EC2::CopyImageResult> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/CopyImage
ATTRIBUTES
ClientToken => Str
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) in the Amazon EC2 API Reference.
Description => Str
A description for the new AMI in the destination Region.
DestinationOutpostArn => Str
The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an AWS 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 Copying AMIs from an AWS Region to an Outpost (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#copy-amis) in the Amazon Elastic Compute Cloud User Guide.
DryRun => Bool
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
.
Encrypted => Bool
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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the Amazon Elastic Compute Cloud User Guide.
KmsKeyId => Str
The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true
.
You can specify a CMK 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.
AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified CMK must exist in the destination Region.
Amazon EBS does not support asymmetric CMKs.
REQUIRED Name => Str
The name of the new AMI in the destination Region.
REQUIRED SourceImageId => Str
The ID of the AMI to copy.
REQUIRED SourceRegion => Str
The name of the Region that contains the AMI to copy.
SEE ALSO
This class forms part of Paws, documenting arguments for method CopyImage in Paws::EC2
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues