Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

Для использования в плейбуке укажите: community.aws.rds_snapshot_info.

Впервые в версии 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'. Дополнительную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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 "ресурс:действие" во время задачи, выводит множество в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_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
всегда
Идентификатор ключа 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
всегда
Идентификатор ключа 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
всегда
Тип хранилища базовой БД

Пример:
gp2
tags
complex
при условии, что снимок не общий
Теги снимка
vpc_id
string
всегда
Идентификатор VPC, содержащего БД

Пример:
vpc-abcd1234


Авторы

  • Will Thames (@willthames)

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

Spec-Zone.ru

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