Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

  • Получение информации об одном или нескольких снимках RDS. Это могут быть снимки отдельных баз данных или снимки кластеров БД (Aurora).
  • Информацию о снимках Aurora можно получить, если параметры идентификатора не указаны или указан один из параметров кластера.
  • Этот модуль впервые добавлен в 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.

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

псевдонимы: snapshot_name

строка

Имя снимка RDS (не кластерного).

Взаимоисключающий параметр с db_instance_identifier, db_cluster_identifier, db_cluster_snapshot_identifier.

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.

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 взаимоисключающие.

snapshot_type

строка

Тип искомого снимка.

По умолчанию возвращаются и автоматические, и ручные снимки.

Варианты:

  • "automated"
  • "manual"
  • "shared"
  • "public"

validate_certs

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

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

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

Варианты:

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

Примечания

Примечание

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

Примеры

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

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

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

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

Ключ

Описание

cluster_snapshots

complex

Список снимков кластеров.

Возвращается: при передаче параметров кластера.

allocated_storage

integer

Выделенный размер хранилища в гибибайтах (GiB).

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

Пример: 1

availability_zones

list / elements=string

Список зон доступности (AZ), в которых можно восстановить экземпляры из снимка кластера БД.

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

Пример: ["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_resource_id

string

Идентификатор ресурса кластера БД, из которого был создан этот снимок кластера БД.

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

Пример: "cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ"

db_cluster_snapshot_arn

string

Имя ресурса Amazon (ARN) снимка кластера БД.6

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

Пример: "arn:aws:rds:ca-central-1:123456789012:cluster-snapshot:test-aurora-snapshot"

db_cluster_snapshot_identifier

string

Идентификатор снимка кластера БД.

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

Пример: "test-aurora-snapshot"

engine

string

Название обработчика базы данных для этого снимка кластера БД.

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

Пример: "aurora"

engine_mode

string

Режим работы обработчика базы данных для этого снимка кластера БД.

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

Пример: "provisioned"

engine_version

string

Версия обработчика базы данных для этого снимка кластера БД.

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

Пример: "5.6.10a"

iam_database_authentication_enabled

boolean

Включено ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями базы данных.

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

Пример: false

kms_key_id

string

Идентификатор ключа Amazon Web Services KMS для зашифрованного снимка кластера БД.

Возвращается: если storage_encrypted имеет значение true

Пример: "arn:aws:kms:us-west-2:123456789012:key/abcd1234-1234-aaaa-0000-1234567890ab"

license_model

string

Сведения о модели лицензирования для этого снимка кластера БД.

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

Пример: "aurora"

master_username

string

Имя пользователя master для этого снимка кластера БД.

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

Пример: "shertel"

percent_progress

integer

Процент расчетного объема данных, переданный на данный момент.

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

Пример: 0

port

integer

Порт, на котором кластер БД прослушивал соединения в момент создания снимка.

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

Пример: 0

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

Выделенный размер хранилища в гибибайтах (GiB).

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

Пример: 10

availability_zone

string

Название зоны доступности, в которой находился экземпляр БД на момент создания снимка БД.

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

Пример: "us-west-2b"

db_instance_identifier

string

Идентификатор экземпляра БД, из которого был создан этот снимок БД.

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

Пример: "hello-world-rds"

db_snapshot_arn

string

Имя ресурса Amazon (ARN) снимка БД.

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

Пример: "arn:aws:rds:us-west-2:123456789012: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"

dbi_resource_id

string

Идентификатор исходного экземпляра БД, который нельзя изменить и который уникален для каждого региона Amazon Web Services.

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

Пример: "db-ABCDEFGHIJKLMNOPQRSTUVWXYZ"

dedicated_log_volume

boolean

Включен ли для экземпляра БД выделенный том журналов (DLV).

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

Пример: false

encrypted

boolean

Зашифрован ли снимок БД.

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

Пример: true

engine

string

Название обработчика базы данных.

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

Пример: "postgres"

engine_version

string

Версия обработчика базы данных.

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

Пример: "9.5.10"

iam_database_authentication_enabled

boolean

Включено ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями базы данных.

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

Пример: false

instance_create_time

string

Время создания экземпляра БД, с которого был сделан снимок.

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

Пример: "2017-10-10T04:00:07.434000+00:00"

iops

integer

Значение Provisioned IOPS (операций ввода-вывода в секунду) для экземпляра БД на момент создания снимка.

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

Пример: 3000

kms_key_id

string

Идентификатор ключа Amazon Web Services KMS для зашифрованного снимка БД.

Возвращается: если encrypted имеет значение true

Пример: "arn:aws:kms:us-west-2:123456789012:key/abcd1234-1234-aaaa-0000-1234567890ab"

license_model

string

Сведения о модели лицензирования восстановленного экземпляра БД.

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

Пример: "postgresql-license"

master_username

string

Имя пользователя master для снимка БД.

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

Пример: "dbadmin"

multi_tenant

boolean

Создан ли снимок экземпляра БД с конфигурацией для нескольких арендаторов (TRUE) или одного арендатора (FALSE).

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

Пример: false

option_group_name

string

Название группы параметров для снимка БД.

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

Пример: "default:postgres-9-5"

original_snapshot_create_time

string

Время выполнения операции CreateDBSnapshot. Не меняется при копировании снимка.

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

Пример: "2017-10-10T04:00:07.434000+00:00"

percent_progress

integer

Процент расчетного объема данных, переданный на данный момент.

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

Пример: 100

port

integer

Порт, на котором обработчик базы данных прослушивал соединения в момент создания снимка.

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

Пример: 0

snapshot_create_time

string

Время создания снимка.

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

Пример: "2018-05-16T04:03:33.871000+00:00"

snapshot_target

string

Где хранятся ручные снимки: в Amazon Web Services Outposts или в регионе Amazon Web Services.

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

Пример: "region"

snapshot_type

string

Тип снимка БД.

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

Пример: "automated"

status

string

Статус этого снимка БД.

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

Пример: "available"

storage_throughput

integer

Пропускная способность хранилища для снимка БД.

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

Пример: 500

storage_type

string

Тип хранилища, связанный со снимком БД.

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

Пример: "gp2"

tags

complex

Теги снимка.

Возвращается: если снимок не является общим.

vpc_id

string

Идентификатор VPC, связанной со снимком БД.

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

Пример: "vpc-abcd1234"

Авторы

  • 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/rds_snapshot_info_module.html

Spec-Zone.ru

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