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