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
debug_botocore_endpoint_logs логический тип добавлен в 2.8	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения playbook. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
description -		Необязательная строка, содержащая описание содержимого и назначения нового AMI.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется в модулях, где требуется регион. Должен быть указан во всех остальных модулях, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
encrypted логический тип добавлен в 2.2	Варианты: нет да	Зашифровать ли копии снимков целевого AMI.
kms_key_id - добавлен в 2.2		Идентификатор ключа KMS, используемый для шифрования образа. Если не указан, используется по умолчанию EBS-ключ шифрования (CMK) для вашей учетной записи.
name -	По умолчанию: "default"	Имя нового AMI для копирования. (Начиная с 2.3 по умолчанию «default», в предыдущих версиях было «null».)
profile строка		Использует профиль 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 строка		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	Варианты: no да ←	Если установлено значение "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
wait boolean	Варианты: нет ← да	Ожидать, пока скопированная AMI перейдет в состояние 'available' перед возвратом.
wait_timeout -	По умолчанию: 600	Время ожидания, в секундах, прежде чем wait прекратит работу. До версии 2.3 значение по умолчанию было 1200. С версии 2.3 по 2.5 этот параметр был устаревшим в пользу значений по умолчанию boto3 waiter. Он был повторно включен в версии 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 (@defunctio) <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.8/modules/ec2_ami_copy_module.html