Use CopyImage with a CLI
The following code examples show how to use CopyImage.
- CLI
-
- Amazon CLI
-
Example 1: To copy an AMI to another Region
The following
copy-imageexample command copies the specified AMI from theus-west-2Region to theus-east-1Region and adds a short description.aws ec2 copy-image \ --regionus-east-1\ --nameami-name\ --source-regionus-west-2\ --source-image-idami-066877671789bd71b\ --description"This is my copied image."Output:
{ "ImageId": "ami-0123456789abcdefg" }For more information, see Copy an AMI
in the Amazon EC2 User Guide. Example 2: To copy an AMI to another Region and encrypt the backing snapshot
The following
copy-imagecommand copies the specified AMI from theus-west-2Region to the current Region and encrypts the backing snapshot using the specified KMS key.aws ec2 copy-image \ --source-regionus-west-2\ --nameami-name\ --source-image-idami-066877671789bd71b\ --encrypted \ --kms-key-idalias/my-kms-keyOutput:
{ "ImageId": "ami-0123456789abcdefg" }For more information, see Copy an AMI
in the Amazon EC2 User Guide. Example 3: To include your user-defined AMI tags when copying an AMI
The following
copy-imagecommand uses the--copy-image-tagsparameter to copy your user-defined AMI tags when copying the AMI.aws ec2 copy-image \ --regionus-east-1\ --nameami-name\ --source-regionus-west-2\ --source-image-idami-066877671789bd71b\ --description"This is my copied image."--copy-image-tagsOutput:
{ "ImageId": "ami-0123456789abcdefg" }For more information, see Copy an AMI
in the Amazon EC2 User Guide. -
For API details, see CopyImage
in Amazon CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell V4
-
Example 1: This example copies the specified AMI in the 'EU (Ireland)' region to the 'US West (Oregon)' region. If -Region is not specified, the current default region is used as the destination region.
Copy-EC2Image -SourceRegion eu-west-1 -SourceImageId ami-12345678 -Region us-west-2 -Name "Copy of ami-12345678"Output:
ami-87654321-
For API details, see CopyImage
in Amazon Tools for PowerShell Cmdlet Reference (V4).
-
- Tools for PowerShell V5
-
Example 1: This example copies the specified AMI in the 'EU (Ireland)' region to the 'US West (Oregon)' region. If -Region is not specified, the current default region is used as the destination region.
Copy-EC2Image -SourceRegion eu-west-1 -SourceImageId ami-12345678 -Region us-west-2 -Name "Copy of ami-12345678"Output:
ami-87654321-
For API details, see CopyImage
in Amazon Tools for PowerShell Cmdlet Reference (V5).
-
For a complete list of Amazon SDK developer guides and code examples, see Create Amazon EC2 resources using an Amazon SDK. This topic also includes information about getting started and details about previous SDK versions.