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)	По умолчанию: "no"	Использовать теги, если исходная AMI уже существует в целевом регионе. Если это значение установлено, и все теги совпадают с существующей AMI, AMI не будет копироваться повторно.
tags		Словарь тегов для добавления к новой скопированной AMI; '{"key":"value"}' и '{"key":"value","key":"value"}'
validate_certs bool (добавлен в 1.5)	Варианты: нет да ←	При значении "нет", сертификаты SSL для boto версии >= 2.6.0 не будут проверяться.
wait bool	Варианты: нет ← да	Ожидать, пока скопированная 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), если учетные данные не предоставлены. См. 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
    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 строка	всегда	Идентификатор AMI скопированной AMI Пример: ami-e689729e

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/ec2_ami_copy_module.html