New in version 2.0.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
aws_access_key
|
Default:
None
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key |
aws_secret_key
|
Default:
None
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key |
description
|
Default:
None
|
An optional human-readable string describing the contents and purpose of the new AMI.
|
ec2_url
|
Default:
None
|
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
|
encrypted
(added in 2.2) |
Default:
None
|
Whether or not the destination snapshots of the copied AMI should be encrypted.
|
kms_key_id
(added in 2.2) |
Default:
None
|
KMS key id used to encrypt image. If not specified, uses default EBS Customer Master Key (CMK) for your account.
|
name
|
Default:
default
|
The name of the new AMI to copy. (As of 2.3 the default is 'default', in prior versions it was 'null'.)
|
profile
(added in 1.6) |
Default:
None
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region |
security_token
(added in 1.6) |
Default:
None
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token |
source_image_id
required |
|
The ID of the AMI in source region that should be copied.
|
source_region
required |
|
The source region the AMI should be copied from.
|
tags
|
Default:
None
|
A hash/dictionary of tags to add to the new copied AMI; '{"key":"value"}' and '{"key":"value","key":"value"}'
|
validate_certs
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
wait
|
|
Wait for the copied AMI to be in state 'available' before returning.
|
wait_timeout
|
Default:
1200
|
How long before wait gives up, in seconds. (As of 2.3 this option is deprecated. See boto3 Waiters)
|
Note
# Basic AMI Copy
- ec2_ami_copy:
source_region: us-east-1
region: eu-west-1
source_image_id: ami-xxxxxxx
# AMI copy wait until available
- ec2_ami_copy:
source_region: us-east-1
region: eu-west-1
source_image_id: ami-xxxxxxx
wait: yes
register: image_id
# Named AMI copy
- ec2_ami_copy:
source_region: us-east-1
region: eu-west-1
source_image_id: ami-xxxxxxx
name: My-Awesome-AMI
description: latest patch
# Tagged AMI copy
- ec2_ami_copy:
source_region: us-east-1
region: eu-west-1
source_image_id: ami-xxxxxxx
tags:
Name: My-Super-AMI
Patch: 1.2.3
# Encrypted AMI copy
- ec2_ami_copy:
source_region: us-east-1
region: eu-west-1
source_image_id: ami-xxxxxxx
encrypted: yes
# Encrypted AMI copy with specified key
- ec2_ami_copy:
source_region: us-east-1
region: eu-west-1
source_image_id: ami-xxxxxxx
encrypted: yes
kms_key_id: arn:aws:kms:us-east-1:XXXXXXXXXXXX:key/746de6ea-50a4-4bcb-8fbc-e3b29f2d367b
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
image_id
string
|
always |
AMI ID of the copied AMI
Sample:
ami-e689729e
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.