Модуль amazon.aws.rds_instance_snapshot – управление снимками экземпляров Amazon RDS

Примечание

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

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

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

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

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

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

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

Создает или удаляет снимки RDS.
Этот модуль впервые был добавлен в community.aws в выпуске 1.0.0.

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа 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 путь	Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Список параметров приведен в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
copy_tags логический добавлен в community.aws 3.3.0	Копировать ли все теги из `source_db_snapshot_identifier` в `db_instance_identifier`. Варианты: `false` ← (по умолчанию) `true`
db_instance_identifier псевдонимы: instance_id строка	Идентификатор экземпляра базы данных. Обязателен при создании снимка.
db_snapshot_identifier псевдонимы: id, snapshot_id строка / обязательный	Снимок, которым нужно управлять.
debug_botocore_endpoint_logs логический	Использовать логгер `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить этот набор в ключ resource_actions в результатах задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
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 и session_token.
purge_tags логический	Если задано значение `purge_tags=true` и параметр `tags` задан, существующие теги ресурса будут удалены, чтобы они в точности соответствовали значениям, заданным параметром `tags`. Если параметр `tags` не задан, теги не будут изменены, даже если `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра `purge_tags` они будут игнорироваться. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_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` (в порядке убывания предпочтения). Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.
session_token псевдонимы: aws_session_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`. Параметры session_token и profile взаимоисключающие.
source_db_snapshot_identifier псевдонимы: source_id, source_snapshot_id строка добавлен в community.aws 3.3.0	Идентификатор исходного снимка БД. Обязателен при копировании снимка. Если исходный снимок находится в том же регионе AWS, что и копия, укажите идентификатор снимка. Если исходный снимок находится в другом регионе AWS, укажите ARN снимка.
source_region строка добавлен в community.aws 3.3.0	Регион, в котором находится копируемый снимок.
state строка	Укажите требуемое состояние снимка. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Словарь с тегами, которые нужно применить к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
validate_certs логический	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать параметр aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait логический	Ожидать ли завершения создания или удаления снимка. Варианты: `false` ← (по умолчанию) `true`
wait_timeout целое число	Сколько времени ждать до прекращения ожидания, в секундах. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Create snapshot
  amazon.aws.rds_instance_snapshot:
    db_instance_identifier: new-database
    db_snapshot_identifier: new-database-snapshot
  register: snapshot

- name: Copy snapshot from a different region and copy its tags
  amazon.aws.rds_instance_snapshot:
    id: new-database-snapshot-copy
    region: us-east-1
    source_id: "{{ snapshot.db_snapshot_arn }}"
    source_region: us-east-2
    copy_tags: true

- name: Delete snapshot
  amazon.aws.rds_instance_snapshot:
    db_snapshot_identifier: new-database-snapshot
    state: absent

Возвращаемые значения

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

Ключ	Описание
allocated_storage integer	Объём выделенного хранилища в ГБ. Возвращается: всегда Пример: `20`
availability_zone string	Зона доступности базы данных, из которой создан снимок. Возвращается: всегда Пример: `"us-west-2a"`
db_instance_identifier string	База данных, из которой создан снимок. Возвращается: всегда Пример: `"ansible-test-16638696"`
db_snapshot_arn string	Имя ресурса Amazon для снимка. Возвращается: всегда Пример: `"arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot"`
db_snapshot_identifier string	Имя снимка. Возвращается: всегда Пример: `"ansible-test-16638696-test-snapshot"`
dbi_resource_id string	Идентификатор исходного экземпляра БД, который нельзя изменить и который уникален для региона AWS. Возвращается: всегда Пример: `"db-MM4P2U35RQRAMWD3QDOXWPZP4U"`
encrypted boolean	Зашифрован ли снимок. Возвращается: всегда Пример: `false`
engine string	Механизм базы данных, из которой создан снимок. Возвращается: всегда Пример: `"mariadb"`
engine_version string	Версия базы данных, из которой создан снимок. Возвращается: всегда Пример: `"10.2.21"`
iam_database_authentication_enabled boolean	Включена ли аутентификация базы данных IAM. Возвращается: всегда Пример: `false`
instance_create_time string	Время создания экземпляра, из которого создан снимок. Возвращается: всегда Пример: `"2019-06-15T10:15:56.221000+00:00"`
license_model string	Модель лицензирования базы данных. Возвращается: всегда Пример: `"general-public-license"`
master_username string	Имя главного пользователя базы данных. Возвращается: всегда Пример: `"test"`
option_group_name string	Группа параметров базы данных. Возвращается: всегда Пример: `"default:mariadb-10-2"`
percent_progress integer	Ход создания снимка в процентах. Для доступного снимка значение равно 100. Возвращается: всегда Пример: `100`
port integer	Порт, на котором база данных принимает соединения. Возвращается: всегда Пример: `3306`
processor_features list / elements=string	Список характеристик процессора базы данных. Возвращается: всегда Пример: `[]`
snapshot_create_time string	Время создания снимка. Возвращается: всегда Пример: `"2019-06-15T10:46:23.776000+00:00"`
snapshot_type string	Способ создания снимка (в этом модуле он всегда создаётся вручную!). Возвращается: всегда Пример: `"manual"`
source_db_snapshot_identifier string добавлено в community.aws 3.3.0	ARN снимка БД, с которого была создана копия этого снимка БД. Возвращается: если снимок является копией Пример: `"arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot-source"`
status string	Статус снимка. Возвращается: всегда Пример: `"available"`
storage_type string	Тип хранилища базы данных. Возвращается: всегда Пример: `"gp2"`
tags complex	Теги, применённые к снимку. Возвращается: всегда
vpc_id string	Идентификатор VPC, в которой находится БД. Возвращается: всегда Пример: `"vpc-09ff232e222710ae0"`

Авторы

Will Thames (@willthames)
Michael De La Rue (@mikedlr)
Alina Buzachis (@alinabuzachis)
Joseph Torcasso (@jatorcasso)

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

© 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/rds_instance_snapshot_module.html