community.aws.lightsail_snapshot модуль – Создает снимки AWS Lightsail экземпляров

Примечание

Этот модуль входит в состав коллекции community.aws (версия 8.0.0).

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

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

Чтобы использовать его в playbook, укажите: community.aws.lightsail_snapshot.

Новая функция в community.aws 6.0.0

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

Описание

Создаёт снимки AWS Lightsail экземпляров.

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа 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 botocore AWS. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение файла сертификата CA для проверки SSL-сертификатов. Также может быть использована переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs булево	Использовать логгер `botocore.endpoint`, чтобы анализировать уникальные (а не все) `"resource:action"` вызовы API во время выполнения задачи, выводя набор в ключ resource_actions результатов задачи. Использовать `aws_resource_action` обратный вызов для вывода всего списка, выполненного во время выполнения плейбука. Также может быть использована переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут быть использованы переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
instance_name строка	Имя экземпляра для создания снимка. Требуется, когда state=present.
profile псевдонимы: aws_profile строка	Используемый именованный профиль 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.
region псевдонимы: aws_region, ec2_region строка	Используемый регион 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 псевдонимы: 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 псевдонимы: 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_name строка / обязательный	Имя нового снимка экземпляра.

END_OF_DOCUMENT_MARKER

состояние строка	Укажите желаемое состояние целевого объекта. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	При установке в значение `false`, сертификаты SSL не будут проверены при общении с API AWS. Настройка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait логическое значение	Дождаться создания моментальной копии экземпляра перед возвратом. Варианты: `false` `true` ← (по умолчанию)
wait_timeout целое число	Сколько времени ждать, прежде чем wait прекратит ожидание, в секундах. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Create AWS Lightsail snapshot
  lightsail_snapshot:
    region: us-east-1
    snapshot_name: "my_instance_snapshot"
    instance_name: "my_instance"

- name: Delete AWS Lightsail snapshot
  lightsail_snapshot:
    region: us-east-1
    snapshot_name: "my_instance_snapshot"
    state: absent

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

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

Ключ	Описание
changed логическое значение	если моментальная копия была изменена/создана Возвращаемое значение: всегда Пример: `{"changed": true}`
snapshot словарь	данные моментальной копии экземпляра Возвращаемое значение: всегда Пример: {"arn": "arn:aws:lightsail:us-east-1:070807442430:InstanceSnapshot/54b0f785-7132-443d-9e32-95a6825636a4", "created_at": "2023-02-23T18:46:11.183000+00:00", "from_attached_disks": [], "from_blueprint_id": "amazon_linux_2", "from_bundle_id": "nano_2_0", "from_instance_arn": "arn:aws:lightsail:us-east-1:070807442430:Instance/5ca1e7ca-a994-4e19-bb82-deb9d79e9ca3", "from_instance_name": "my_instance", "is_from_auto_snapshot": false, "location": {"availability_zone": "all", "region_name": "us-east-1"}, "name": "my_instance_snapshot", "resource_type": "InstanceSnapshot", "size_in_gb": 20, "state": "available", "support_code": "351201681302/ami-06b48e5589f1e248b", "tags": []}

Ключ

Описание

changed

логическое значение

если моментальная копия была изменена/создана

Возвращаемое значение: всегда

Пример: {"changed": true}

snapshot

словарь

данные моментальной копии экземпляра

Возвращаемое значение: всегда

Пример: {"arn": "arn:aws:lightsail:us-east-1:070807442430:InstanceSnapshot/54b0f785-7132-443d-9e32-95a6825636a4", "created_at": "2023-02-23T18:46:11.183000+00:00", "from_attached_disks": [], "from_blueprint_id": "amazon_linux_2", "from_bundle_id": "nano_2_0", "from_instance_arn": "arn:aws:lightsail:us-east-1:070807442430:Instance/5ca1e7ca-a994-4e19-bb82-deb9d79e9ca3", "from_instance_name": "my_instance", "is_from_auto_snapshot": false, "location": {"availability_zone": "all", "region_name": "us-east-1"}, "name": "my_instance_snapshot", "resource_type": "InstanceSnapshot", "size_in_gb": 20, "state": "available", "support_code": "351201681302/ami-06b48e5589f1e248b", "tags": []}

Авторы

Нуно Сааведра (@Nfsaavedra)

Ссылки на сборку

© 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/community/aws/lightsail_snapshot_module.html