ec2_ami_copy — копирует AMI между регионами AWS, возвращает новый идентификатор изображения
Новое в версии 2.0.
Обзор
- Копирует AMI из исходного региона в целевой регион. С версии 2.3 этот модуль зависит от boto3.
Требования (к хосту, на котором выполняется модуль)
- boto
- boto3
- python >= 2.6
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| aws_access_key |
нет | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
псевдонимы: ec2_access_key, access_key
|
||
| aws_secret_key |
нет | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
псевдонимы: ec2_secret_key, secret_key
|
||
| description |
нет | Необязательная строка для отображения, описывающая содержимое и назначение новой AMI.
|
||
| ec2_url |
нет | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
|
||
| encrypted (добавлено в 2.2)
|
нет | Зашифровать ли целевые снимки скопированной AMI.
|
||
| kms_key_id (добавлено в 2.2)
|
нет | Идентификатор ключа KMS, используемый для шифрования изображения. Если не указан, используется по умолчанию EBS Customer Master Key (CMK) для вашей учетной записи.
|
||
| name |
нет | default | Имя новой AMI для копирования. (Начиная с версии 2.3 значение по умолчанию — «default», в предыдущих версиях — «null».)
|
|
| profile (добавлено в 1.6)
|
нет | Использует профиль boto. Работает только с boto >= 2.24.0.
|
||
| region |
нет | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region
|
||
| security_token (добавлено в 1.6)
|
нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token
|
||
| source_image_id |
да | Идентификатор AMI в исходном регионе, который необходимо скопировать.
|
||
| source_region |
да | Исходный регион, из которого необходимо скопировать AMI.
|
||
| tags |
нет | Хэш/словарь тегов для добавления к новой скопированной AMI; '{"key":"value"}' и '{"key":"value","key":"value"}'
|
||
| validate_certs (добавлено в 1.5)
|
нет | да |
|
Если установлено «нет», сертификаты SSL для версий boto >= 2.6.0 не будут проверены.
|
| wait |
нет | нет |
|
Ожидание состояния скопированной AMI «available» перед возвратом.
|
| wait_timeout |
нет | 1200 | Время ожидания, прежде чем wait прекратит работу, в секундах. (Начиная с 2.3 этот параметр устарел. См. обработчики boto3.)
|
Примеры
# 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
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION. - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это требуется, но это также можно настроить в конфигурационном файле boto
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вас это заинтересует, прочитайте Справочную информацию по сообществу и помощь в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_ami_copy_module.html