ec2_snapshot_copy – копирует снимок EC2 и возвращает новый идентификатор снимка.
Новое в версии 2.4.
Описание
- Копирует снимок EC2 из исходной области в целевую область.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- 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 - | Необязательная строка с описанием нового снимка для чтения человеком. | |
| ec2_url - | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое имеется. | |
| encrypted boolean |
| Зашифровать ли целевой снимок. |
| kms_key_id - | Идентификатор ключа KMS, используемый для шифрования снимка. Если не указан, по умолчанию используется EBS Customer Master Key (CMK) для этой учетной записи. | |
| 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_region - / обязательно | Исходная область, из которой следует скопировать снимок. | |
| source_snapshot_id - / обязательно | Идентификатор снимка в исходной области, который следует скопировать. | |
| tags - | Словарь тегов для добавления к новому снимку; '{"ключ":"значение"}' и '{"ключ":"значение","ключ":"значение"}' | |
| validate_certs boolean добавлен в 1.5 |
| При значении "нет" сертификаты SSL для boto версий >= 2.6.0 не будут проверяться. |
| wait boolean |
| Ожидание, пока скопированный снимок не перейдет в состояние 'Доступен', перед возвратом. |
| wait_timeout - добавлен в 2.6 | По умолчанию: 600 | Время ожидания в секундах, после которого ожидание прекратится. |
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета
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 Snapshot Copy
- ec2_snapshot_copy:
source_region: eu-central-1
region: eu-west-1
source_snapshot_id: snap-xxxxxxx
# Copy Snapshot and wait until available
- ec2_snapshot_copy:
source_region: eu-central-1
region: eu-west-1
source_snapshot_id: snap-xxxxxxx
wait: yes
wait_timeout: 1200 # Default timeout is 600
register: snapshot_id
# Tagged Snapshot copy
- ec2_snapshot_copy:
source_region: eu-central-1
region: eu-west-1
source_snapshot_id: snap-xxxxxxx
tags:
Name: Snapshot-Name
# Encrypted Snapshot copy
- ec2_snapshot_copy:
source_region: eu-central-1
region: eu-west-1
source_snapshot_id: snap-xxxxxxx
encrypted: yes
# Encrypted Snapshot copy with specified key
- ec2_snapshot_copy:
source_region: eu-central-1
region: eu-west-1
source_snapshot_id: snap-xxxxxxx
encrypted: yes
kms_key_id: arn:aws:kms:eu-central-1:XXXXXXXXXXXX:key/746de6ea-50a4-4bcb-8fbc-e3b29f2d367b
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| snapshot_id строка | при успешной копировании снимка | идентификатор нового снимка Пример: snap-e9095e8c |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Deepak Kothandan <deepak.kdy@gmail.com>
Подсказка
Если вы обнаружите проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 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_snapshot_copy_module.html