Spec-Zone.ru › Ansible 2.10

community.aws.rds_snapshot_facts – получение информации об одном или нескольких снимках RDS

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.rds_snapshot_facts.

Новое в версии 1.0.0: из community.aws

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

Описание

  • Получение информации об одном или нескольких снимках RDS. Это могут быть снимки для несгруппированных или снимков кластеров БД (Aurora).
  • Информация о снимках Aurora может быть получена, если не передаются параметры идентификаторов или передаются параметры кластера.
  • Этот модуль назывался rds_snapshot_facts до Ansible 2.9. Использование не изменилось.

Требования

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

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если установлен параметр profile, этот параметр игнорируется.
Передача параметров aws_access_key и profile одновременно устарела и эти параметры станут взаимоисключающими после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение пакета сертификатов CA для проверки SSL-сертификатов.
Используется только для модулей на основе boto3.
Примечание: пакет CA считывается со стороны модуля и может потребоваться явное копирование с контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если установлен параметр profile, этот параметр игнорируется.
Передача параметров aws_secret_key и profile одновременно устарела и эти параметры станут взаимоисключающими после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
db_cluster_identifier
строка
Имя кластера RDS, для которого необходимо найти снимки.
Взаимоисключительно с db_snapshot_identifier, db_instance_identifier, db_cluster_snapshot_identifier
db_cluster_snapshot_identifier
строка
Имя снимка кластера RDS.
Взаимоисключительно с db_instance_identifier, db_snapshot_identifier, db_cluster_identifier
db_instance_identifier
строка
Имя экземпляра RDS, для которого необходимо найти снимки.
Взаимоисключительно с db_snapshot_identifier, db_cluster_identifier, db_cluster_snapshot_identifier
db_snapshot_identifier
строка
Имя снимка RDS (несгруппированного).
Взаимоисключительно с db_instance_identifier, db_cluster_identifier, db_cluster_snapshot_identifier

псевдонимы: snapshot_name
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Использование логирования botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводящих набор в ключ task_results. Использовать обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения книги задач. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если таковая имеется.

псевдонимы: aws_endpoint_url, endpoint_url
profile
строка
Использование профиля boto. Работает только с boto >= 2.24.0.
Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка одновременной передачи этих параметров с profile устарела.
aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
region
строка
Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если установлен параметр profile, этот параметр игнорируется.
Передача параметров security_token и profile одновременно устарела и эти параметры станут взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
snapshot_type
строка
    Варианты:
  • automated
  • manual
  • shared
  • public
Тип снимка для поиска.
По умолчанию будут возвращены как автоматические, так и ручные снимки.
validate_certs
булево
    Варианты:
  • нет
  • да ←
При установке в «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если данные учетных данных не указаны. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- name: Get information about an snapshot
  community.aws.rds_snapshot_info:
    db_snapshot_identifier: snapshot_name
  register: new_database_info

- name: Get all RDS snapshots for an RDS instance
  community.aws.rds_snapshot_info:
    db_instance_identifier: helloworld-rds-master

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

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

Ключ Возвращаемое значение Описание
cluster_snapshots
complex
всегда
Список снимков кластера
allocated_storage
integer
всегда
Количество выделенных гигабайт хранилища

Пример:
1
availability_zones
list / elements=string
всегда
Доступные зоны для базы данных, со снимка которой был сделан снимок

Пример:
['ca-central-1a', 'ca-central-1b']
cluster_create_time
string
всегда
Дата и время создания кластера

Пример:
2018-05-17T00:13:40.223000+00:00
db_cluster_identifier
string
всегда
Идентификатор кластера базы данных

Пример:
test-aurora-cluster
db_cluster_snapshot_arn
string
всегда
ARN снимка базы данных

Пример:
arn:aws:rds:ca-central-1:111111111111:cluster-snapshot:test-aurora-snapshot
db_cluster_snapshot_identifier
string
всегда
Идентификатор снимка

Пример:
test-aurora-snapshot
engine
string
всегда
Двигатель базы данных

Пример:
aurora
engine_version
string
всегда
Версия двигателя базы данных

Пример:
5.6.10a
iam_database_authentication_enabled
boolean
всегда
Включена ли аутентификация базы данных через IAM
kms_key_id
string
всегда
ID ключа KMS, шифрующего снимок

Пример:
arn:aws:kms:ca-central-1:111111111111:key/abcd1234-abcd-1111-aaaa-0123456789ab
license_model
string
всегда
Модель лицензии

Пример:
aurora
master_username
string
всегда
Имя пользователя мастера базы данных

Пример:
shertel
percent_progress
integer
всегда
Процент завершения снимка
port
integer
всегда
Порт базы данных
snapshot_create_time
string
всегда
Дата и время создания снимка

Пример:
2018-05-17T00:23:23.731000+00:00
snapshot_type
string
всегда
Тип снимка

Пример:
manual
status
string
всегда
Статус снимка

Пример:
creating
storage_encrypted
boolean
всегда
Зашифрован ли снимок

Пример:
True
tags
complex
при отсутствии совместного доступа к снимку
Теги снимка
vpc_id
string
всегда
VPC базы данных

Пример:
vpc-abcd1234
snapshots
complex
При отсутствии параметров кластера
Список снимков, не относящихся к кластеру
allocated_storage
integer
всегда
Количество выделенных гигабайт хранилища

Пример:
10
availability_zone
string
всегда
Доступная зона базы данных, со снимка которой был сделан снимок

Пример:
us-west-2b
db_instance_identifier
string
всегда
Идентификатор экземпляра базы данных

Пример:
hello-world-rds
db_snapshot_arn
string
всегда
ARN снимка

Пример:
arn:aws:rds:us-west-2:111111111111:snapshot:rds:hello-world-rds-us1-2018-05-16-04-03
db_snapshot_identifier
string
всегда
Имя снимка

Пример:
rds:hello-world-rds-us1-2018-05-16-04-03
encrypted
boolean
всегда
Зашифрован ли снимок

Пример:
True
engine
string
всегда
Двигатель базы данных

Пример:
postgres
engine_version
string
всегда
Версия двигателя базы данных

Пример:
9.5.10
iam_database_authentication_enabled
boolean
всегда
Включена ли аутентификация базы данных через IAM
instance_create_time
string
всегда
Время создания экземпляра

Пример:
2017-10-10T04:00:07.434000+00:00
kms_key_id
string
всегда
ID ключа KMS, шифрующего снимок

Пример:
arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab
license_model
string
всегда
Модель лицензии

Пример:
postgresql-license
master_username
string
всегда
Имя пользователя мастера базы данных

Пример:
dbadmin
option_group_name
string
всегда
Имя группы параметров базы данных

Пример:
default:postgres-9-5
percent_progress
integer
всегда
Процент завершения снимка

Пример:
100
snapshot_create_time
string
всегда
Время создания снимка

Пример:
2018-05-16T04:03:33.871000+00:00
snapshot_type
string
всегда
Тип снимка

Пример:
automated
status
string
всегда
Статус снимка

Пример:
available
storage_type
string
всегда
Тип хранилища для underlying DB

Пример:
gp2
tags
complex
при отсутствии совместного доступа к снимку
Теги снимка
vpc_id
string
всегда
ID VPC, содержащей DB

Пример:
vpc-abcd1234


Авторы

  • Will Thames (@willthames)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/rds_snapshot_facts_module.html

Spec-Zone.ru

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