Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_snapshot.

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

Следующие требования должны быть выполнены на узле, который выполняет этот модуль.

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_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 (в порядке убывания приоритета).

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

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

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 для анализа уникальных (а не всех) вызовов API "resource:action", выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести полный список вызовов, выполненных во время плейбука.

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

Варианты:

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

description

string

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

device_name

string

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

endpoint_url

aliases: aws_endpoint_url

string

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

Также можно использовать переменную среды AWS_URL.

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 и session_token.

purge_create_vol_permission

boolean

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

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

Если параметр purge_create_vol_permission задан в значение True, необходимо установить для modify_create_vol_permission значение True.

Варианты:

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

region

aliases: aws_region

string

Регион AWS.

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

Также можно использовать переменную среды AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

aliases: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа 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 (в порядке убывания приоритета).

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

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

session_token

aliases: aws_session_token

string

Токен сеанса 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.

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

snapshot_id

string

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

snapshot_tags

dictionary

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

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

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

state

string

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

Варианты:

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

user_ids

list / elements=string

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

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

Если для createVolumePermission снимка задано значение Public (то есть group_names=all), указание user_ids не сделает createVolumePermission закрытым, если для modify_create_vol_permission не задано значение true.

Взаимоисключающий параметр с group_names.

validate_certs

boolean

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

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

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

volume_id

string

Том, снимок которого нужно создать.

wait

boolean

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

Варианты:

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

wait_timeout

integer

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

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» 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

string

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

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

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

snapshots

list / elements=dictionary

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

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

description

string

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

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

Пример: ""

encrypted

boolean

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

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

Пример: false

owner_id

string

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

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

Пример: "123456"

progress

string

Ход выполнения создания этого снимка.

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

Пример: ""

snapshot_id

string

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

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

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

start_time

string

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

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

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

state

string

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

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

Пример: "pending"

tags

dictionary

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

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

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

volume_id

string

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

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

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

volume_size

integer

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

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

Пример: 8

tags

dictionary

Все теги, назначенные снимку.

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

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

volume_id

string

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

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

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

volume_size

integer

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

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

Пример: 8

Авторы

  • Will Thames (@willthames)

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

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

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

Spec-Zone.ru

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