There are more AWS SDK examples available in the AWS Doc SDK Examples
Use CopyImage
with a CLI
The following code examples show how to use CopyImage
.
- CLI
-
- AWS CLI
-
Example 1: To copy an AMI to another Region
The following
copy-image
example command copies the specified AMI from theus-west-2
Region to theus-east-1
Region and adds a short description.aws ec2 copy-image \ --region
us-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-image
command copies the specified AMI from theus-west-2
Region to the current Region and encrypts the backing snapshot using the specified KMS key.aws ec2 copy-image \ --source-region
us-west-2
\ --nameami-name
\ --source-image-idami-066877671789bd71b
\ --encrypted \ --kms-key-idalias/my-kms-key
Output:
{ "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-image
command uses the--copy-image-tags
parameter to copy your user-defined AMI tags when copying the AMI.aws ec2 copy-image \ --region
us-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 AWS CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell
-
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 AWS Tools for PowerShell Cmdlet Reference.
-