/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::EC2::CopyImage

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');
my $CopyImageResult = $ec2->CopyImage(
  Name          => 'MyString',
  SourceImageId => 'MyString',
  SourceRegion  => 'MyString',
  ClientToken   => 'MyString',      # OPTIONAL
  Description   => 'MyString',      # OPTIONAL
  DryRun        => 1,               # OPTIONAL
  Encrypted     => 1,               # OPTIONAL
  KmsKeyId      => 'MyKmsKeyId',    # OPTIONAL
);

# 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 How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) in the Amazon Elastic Compute Cloud User Guide.

Description => Str

A description for the new AMI in the destination Region.

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

An identifier for the symmetric 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.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333: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.

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