Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_snapshot — Создаёт снимок EC2 из существующего тома EBS

Примечание

Этот модуль является частью коллекции amazon.aws (версия 8.2.1).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook укажите: amazon.aws.ec2_snapshot.

Добавлена в amazon.aws 1.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Создаёт снимок EC2 из существующего тома EBS.

Требования

Ниже приведены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа AWS.

См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время playbook.

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

  • false ← (по умолчанию)
  • true

description

string

Описание, которое будет применено к снимку.

device_name

string

Имя устройства смонтированного тома, который будет снят.

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только на AWS.

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

group_names

list / elements=string

добавлено в amazon.aws 6.1.0

Группа, которая будет добавлена или удалена. Возможным значением является all.

Взаимоисключающе с user_ids.

Варианты:

  • "all"

instance_id

string

Экземпляр, имеющий необходимый том для создания снимка.

last_snapshot_min_age

integer

Если создание последнего снимка тома началось менее чем last_snapshot_min_age минут назад, новый снимок создаваться не будет.

По умолчанию: 0

modify_create_vol_permission

boolean

добавлено в amazon.aws 6.1.0

Если установлено в true, разрешения createVolumePermissions снимка ec2 могут быть изменены.

Варианты:

  • false
  • true

profile

aliases: aws_profile

string

Именованный профиль AWS для использования при аутентификации.

См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Переменная среды AWS_PROFILE также может использоваться.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.

purge_create_vol_permission

boolean

добавлено в amazon.aws 6.1.0

Следует ли удалять неуказанные имена групп или идентификаторы пользователей из createVolumePermission снимка.

Необходимо установить modify_create_vol_permission в True для случая, когда purge_create_vol_permission установлено в True.

Варианты:

  • false ← (по умолчанию)
  • true

region

aliases: aws_region, ec2_region

string

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется.

Переменные среды AWS_REGION или EC2_REGION также могут использоваться.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

строка

Токен сессии AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

snapshot_id

строка

Идентификатор снимка для удаления.

snapshot_tags

словарь

Словарь тегов для добавления к снимку.

Если у тома есть тег Name, он будет автоматически добавлен к снимку.

По умолчанию: {}

state

строка

Добавить или создать снимок.

Выборы:

  • "absent"
  • "present" ← (по умолчанию)

user_ids

список / элементы=строка

добавлено в amazon.aws 6.1.0

Идентификаторы пользователей учетной записи для добавления или удаления.

Если createVolumePermission на снимке в настоящее время установлен на Public, т.е. group_names=all, предоставление user_ids не сделает createVolumePermission Private, если modify_create_vol_permission не установлен на true.

Взаимоисключающие с group_names.

validate_certs

логическое

При установке в false, сертификаты SSL не будут проверяться для связи с API AWS.

Установка validate_certs=false настоятельно не рекомендуется, как альтернатива, рассмотрите установку aws_ca_bundle вместо этого.

Выборы:

  • false
  • true ← (по умолчанию)

volume_id

строка

Том, для которого необходимо создать снимок.

wait

логическое

Ожидать готовности снимка.

Выборы:

  • false
  • true ← (по умолчанию)

wait_timeout

целое число

Время ожидания, прежде чем ожидание прекратится, в секундах.

По умолчанию: 600

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост» и не из контекста «контроллер». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Подробнее см. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Simple snapshot of volume using volume_id
- amazon.aws.ec2_snapshot:
    volume_id: vol-abcdef12
    description: snapshot of /data from DB123 taken 2013/11/28 12:18:32

# Snapshot of volume mounted on device_name attached to instance_id
- amazon.aws.ec2_snapshot:
    instance_id: i-12345678
    device_name: /dev/sdb1
    description: snapshot of /data from DB123 taken 2013/11/28 12:18:32

# Snapshot of volume with tagging
- amazon.aws.ec2_snapshot:
    instance_id: i-12345678
    device_name: /dev/sdb1
    snapshot_tags:
      frequency: hourly
      source: /data

# Remove a snapshot
- amazon.aws.ec2_snapshot:
    snapshot_id: snap-abcd1234
    state: absent

# Create a snapshot only if the most recent one is older than 1 hour
- amazon.aws.ec2_snapshot:
    volume_id: vol-abcdef12
    last_snapshot_min_age: 60

- name: Reset snapshot createVolumePermission (change permission to "Private")
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true

- name: Modify snapshot createVolmePermission to add user IDs (specify purge_create_vol_permission=true to change permssion to "Private")
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    user_ids:
      - '123456789012'
      - '098765432109'

- name: Modify snapshot createVolmePermission - remove all except specified user_ids
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true
    user_ids:
      - '123456789012'

- name: Replace (purge existing) snapshot createVolmePermission annd add user IDs
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true
    user_ids:
      - '111111111111'

- name: Modify snapshot createVolmePermission - make createVolumePermission "Public"
  amazon.aws.ec2_snapshot:
    snapshot_id: snap-06a6f641234567890
    modify_create_vol_permission: true
    purge_create_vol_permission: true
    group_names:
      - all

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ

Описание

snapshot_id

строка

Идентификатор снимка. Каждый снимок получает уникальный идентификатор при создании.

Возвращается: всегда

Пример: "snap-01234567"

snapshots

список / элементы=словарь

Список снимков.

Возвращается: всегда

description

строка

Описание, указанное в CreateSnapshotRequest, которое применено ко всем снимкам.

Возвращается: всегда

Пример: ""

encrypted

булево

Указывает, зашифрован ли снимок.

Возвращается: всегда

Пример: false

owner_id

строка

Идентификатор учетной записи, используемый при создании снимка.

Возвращается: всегда

Пример: "123456"

progress

строка

Прогресс, достигнутый снимком в процессе завершения.

Возвращается: всегда

Пример: ""

snapshot_id

строка

Идентификатор снимка, который можно использовать для описания этого снимка.

Возвращается: всегда

Пример: "snap-1234"

start_time

строка

Время начала создания снимка. Это значение одинаково для всех снимков, начатых одним запросом.

Возвращается: всегда

Пример: "2024-05-07T14:29:24.523000+00:00"

state

строка

Текущее состояние снимка.

Возвращается: всегда

Пример: "pending"

tags

словарь

Теги, связанные с этим снимком.

Возвращается: всегда

Пример: {"Name": "instance-name"}

volume_id

строка

Идентификатор тома, который использовался для создания снимка.

Возвращается: всегда

Пример: "vol-01234567"

volume_size

целое число

Размер тома в ГБ.

Возвращается: всегда

Пример: 8

tags

словарь

Любые теги, назначенные снимку.

Возвращается: всегда

Пример: {"Name": "instance-name"}

volume_id

строка

Идентификатор тома, который использовался для создания снимка.

Возвращается: всегда

Пример: "vol-01234567"

volume_size

целое число

Размер тома в ГБ.

Возвращается: всегда

Пример: 8

Авторы

  • Will Thames (@willthames)

Ссылки на коллекции

  • Система отслеживания ошибок
  • Репозиторий (исходные коды)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/ec2_snapshot_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API