ec2_ami_copy – копирует AMI между регионами AWS, возвращает новый идентификатор изображения

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Копирует 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 для вывода общего списка, созданного во время выполнения книги задач. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
description -		Необязательная строка с описанием содержимого и назначения новой AMI, написанная для человека.
ec2_url строка		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL (если она существует).
encrypted логический тип	Варианты: нет да	Зашифровать ли резервные копии создаваемых снимков скопированной AMI.
kms_key_id -		Идентификатор ключа KMS, используемого для шифрования изображения. Если не указан, используется стандартный ключ шифрования EBS CMK (Customer Master Key) вашей учетной записи.
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	Варианты: нет да ←	При значении "нет", сертификаты 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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается сообществом 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.9/modules/ec2_ami_copy_module.html