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. | |
| tag_equality - добавлено в 2.6 | По умолчанию: "нет" | Использовать теги, если исходный AMI уже существует в целевом регионе. Если установлено, и все теги совпадают в существующем AMI, AMI не будет копироваться повторно. |
| tags - | Словарь тегов для добавления к новому скопированному AMI; '{"ключ":"значение"}' и '{"ключ":"значение","ключ":"значение"}' | |
| validate_certs boolean добавлено в 1.5 |
| При значении "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| wait boolean |
| Подождать, пока скопированный AMI перейдет в состояние 'available' перед возвратом. |
| wait_timeout - | Значение по умолчанию: 600 | Сколько времени ждать, прежде чем прекратить ожидание, в секундах. До версии 2.3 значение по умолчанию составляло 1200. С версии 2.3 по 2.5 этот параметр был устаревшим в пользу значений по умолчанию ожидания boto3. Он был снова включён в версии 2.6, чтобы разрешить таймауты больше 10 минут. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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
wait_timeout: 1200 # Default timeout is 600
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 (will not copy the same AMI twice)
- 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
tag_equality: yes
# 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 строка | всегда | ID AMI скопированной AMI Пример: ami-e689729e |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Amir Moulavi (@amir343) <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.7/modules/ec2_ami_copy_module.html