Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook, укажите: amazon.aws.rds_snapshot_info.

Новое в amazon.aws 5.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа 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 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в версии после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в версии после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

db_cluster_identifier

string

Имя кластера RDS, для которого необходимо найти снимки.

Взаимоисключающе с db_snapshot_identifier, db_instance_identifier, db_cluster_snapshot_identifier.

db_cluster_snapshot_identifier

string

Имя снимка кластера RDS.

Взаимоисключающе с db_instance_identifier, db_snapshot_identifier, db_cluster_identifier.

db_instance_identifier

string

Имя экземпляра RDS, для которого необходимо найти снимки.

Взаимоисключающе с db_snapshot_identifier, db_cluster_identifier, db_cluster_snapshot_identifier.

db_snapshot_identifier

aliases: snapshot_name

string

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

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

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, созданный во время playbook.

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS.

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в версии после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в версии после 2024-12-01.

profile

aliases: aws_profile

string

Именованный профиль 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

aliases: aws_region, ec2_region

string

Регион 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

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа 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 для согласованности с AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в версии после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в версии после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию об access токенах см. в документации 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_type

string

Тип снимка для поиска.

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

Возможные значения:

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

validate_certs

boolean

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

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

Возможные значения:

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

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллер». Поэтому, возможно, потребуется явно скопировать файлы на «хост». Для плагинов поиска и подключения переменные окружения и конфигурационные файлы читаются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

Сколько гигабайт памяти выделено.

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

Пример: 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:123456789012: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.

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

Пример: false

kms_key_id

string

ID ключа KMS, шифрующего снимок.

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

Пример: "arn:aws:kms:ca-central-1:123456789012:key/abcd1234-abcd-1111-aaaa-0123456789ab"

license_model

string

Модель лицензирования.

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

Пример: "aurora"

master_username

string

Имя пользователя администратора базы данных.

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

Пример: "shertel"

percent_progress

integer

Процент выполнения создания снимка.

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

Пример: 0

port

integer

Порт базы данных.

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

Пример: 0

snapshot_create_time

string

Дата и время создания снимка.

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

Пример: "2018-05-17T00:23:23.731000+00:00"

snapshot_type

string

Тип снимка.

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

Пример: "manual"

статус

строка

Состояние снимка.

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

Пример: "creating"

storage_encrypted

логическое

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

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

Пример: true

теги

сложный

Теги снимка.

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

vpc_id

строка

VPC базы данных.

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

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

Авторы

  • Уилл Темес (@willthames)

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

  • Система отслеживания задач
  • Репозиторий (исходники)
  • Связь

© 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/amazon/aws/rds_snapshot_info_module.html

Spec-Zone.ru

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