Spec-Zone.ru › Ansible

Модуль community.aws.dynamodb_table_info – Возвращает информацию о таблице Dynamo DB

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.aws.dynamodb_table_info.

Новая в community.aws 7.2.0

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

Описание

  • Возвращает информацию о таблице Dynamo DB, включая текущий статус таблицы, время её создания, схему первичного ключа и любые индексы в таблице.

Требования

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

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

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_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 или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

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

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

aws_ca_bundle

путь

Расположение файла сертификата CA для проверки SSL-сертификатов.

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

aws_config

словарь

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

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

debug_botocore_endpoint_logs

логический

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

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

Варианты:

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

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

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

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

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

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

name

строка / обязательно

Имя таблицы для описания.

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 и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Используемый регион 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

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

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

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

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, 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.

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: Return information about the DynamoDB table named 'my-table'
  community.aws.dynamodb_table_info:
    name: my-table

Значения возврата

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

Ключ

Описание

table

сложное

Возвращаемые параметры таблицы из вызова API describe.

Возвращается: успешно

archival_summary

сложное

Содержит информацию об архиве таблицы.

Возвращается: при наличии, в таблице

archival_backup_arn

строка

Amazon Resource Name (ARN) резервной копии, в которую была архивирована таблица, применимо в поле причины архивирования.

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

archival_date_time

строка

Дата и время инициирования архивации таблицы DynamoDB в формате временной метки UNIX.

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

archival_reason

строка

Причина архивации таблицы DynamoDB.

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

Пример: "INACCESSIBLE_ENCRYPTION_CREDENTIALS"

attribute_definitions

сложное

Список атрибутов для описания схемы ключей для таблицы и индексов.

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

attribute_name

строка

Имя атрибута.

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

attribute_type

строка

Тип данных атрибута, S (Строка), N (Число) и B (Бинарный).

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

billing_mode

строка

Управляет способом оплаты за пропускную способность чтения и записи и управлением емкостью.

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

creation_date_time

строка

Дата и время создания таблицы в формате временной метки UNIX.

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

deletion_protection_enabled

булево

Указывает, включена ли защита от удаления (true) или выключена (false) для таблицы.

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

Пример: true

global_secondary_indexes

список / элементы=словарь

Глобальные вторичные индексы таблицы.

Возвращается: при наличии в таблице

global_table_version

строка

Представляет версию глобальных таблиц, если таблица дублируется по областям AWS.

Возвращается: если таблица дублируется

item_count

целое число

Количество элементов в указанной таблице.

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

key_schema

сложное

Список схем ключей, определяющих атрибуты, составляющие первичный ключ таблицы или атрибуты ключа индекса.

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

attribute_name

строка

Имя атрибута ключа.

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

key_type

строка

Роль, которую будет выполнять этот атрибут ключа: «HASH» для разделяющего ключа, «RANGE» для сортировочного ключа.

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

latest_stream_arn

строка

Amazon Resource Name (ARN), уникально определяющий последний поток для этой таблицы.

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

latest_stream_label

строка

Отметка времени в формате ISO 8601 для этого потока.

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

local_secondary_indexes

list / elements=dictionary

Представляет один или несколько локальных вторичных индексов в таблице.

Возвращается: если есть, в таблице

provisioned_throughput

dictionary

Параметры предварительно настроенной пропускной способности для таблицы.

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

Пример: {"number_of_decreases_today": 0, "read_capacity_units": 1, "write_capacity_units": 1}

replicas

list / elements=dictionary

Представляет реплики таблицы.

Возвращается: если есть, в таблице

restore_date_time

string

Точка во времени или время исходного резервного копирования.

Возвращается: если есть, в таблице

restore_in_progress

boolean

Указывает, выполняется ли восстановление или нет.

Возвращается: если есть, в таблице

source_backup_arn

string

Универсальное имя ресурса (ARN) резервной копии, из которой была восстановлена таблица.

Возвращается: если есть, в таблице

source_table_arn

string

ARN исходной таблицы резервной копии, которая восстанавливается.

Возвращается: если есть, в таблице

sse_description

dictionary

Описание состояния шифрования на стороне сервера в указанной таблице.

Возвращается: если есть, в таблице

Пример: {}

stream_specification

complex

Текущая конфигурация DynamoDB Streams для таблицы.

Возвращается: если есть, в таблице

stream_enabled

boolean

Указывает, включен (true) или отключен (false) DynamoDB Streams в таблице.

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

Пример: true

stream_view_type

string

Когда элемент в таблице изменяется, stream_view_type определяет, какая информация записывается в поток для этой таблицы.

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

Пример: "KEYS_ONLY"

table_arn

string

Универсальное имя ресурса (ARN), однозначно идентифицирующее таблицу.

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

table_class

string

Класс таблицы указанной таблицы.

Возвращается: если есть, в таблице

Пример: "STANDARD_INFREQUENT_ACCESS"

table_id

string

Уникальный идентификатор таблицы, для которой была создана резервная копия.

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

table_name

string

Имя таблицы.

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

table_size_bytes

integer

Общий размер указанной таблицы в байтах.

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

table_status

string

Текущее состояние таблицы.

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

Пример: "ACTIVE"

tags

dictionary

Словарь тегов, связанных с таблицей DynamoDB.

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

Авторы

  • Aubin Bikouo (@abikouo)

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

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

© 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/community/aws/dynamodb_table_info_module.html

Spec-Zone.ru

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