Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Добавлено в community.aws 7.2.0

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

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

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.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

путь

Путь к пакету сертификатов 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 для анализа уникальных (а не всех) вызовов API "resource:action", выполненных во время задачи, и записывать этот набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных в плейбуке.

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

Варианты:

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

endpoint_url

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

строка

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

Также можно использовать переменную окружения AWS_URL.

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

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

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

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

Ключ

Описание

table

complex

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

Возвращается: при успехе

archival_summary

complex

Содержит сведения об архиве таблицы.

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

archival_backup_arn

string

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

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

archival_date_time

string

Дата и время начала архивации таблицы службой DynamoDB в формате времени UNIX epoch.

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

archival_reason

string

Причина архивации таблицы службой DynamoDB.

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

Пример: "INACCESSIBLE_ENCRYPTION_CREDENTIALS"

attribute_definitions

complex

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

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

attribute_name

string

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

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

attribute_type

string

Тип данных атрибута: S (String), N (Number) и B (Binary).

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

billing_mode

string

Определяет порядок оплаты пропускной способности чтения и записи, а также управления емкостью.

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

creation_date_time

string

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

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

deletion_protection_enabled

boolean

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

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

Пример: true

global_secondary_indexes

list / elements=dictionary

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

Возвращается: если имеются, для таблицы

global_table_version

string

Версия глобальных таблиц, используемая в случае репликации таблицы между регионами AWS.

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

item_count

integer

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

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

key_schema

complex

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

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

attribute_name

string

Имя ключевого атрибута.

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

key_type

string

Роль ключевого атрибута: ‘HASH’ для ключа раздела, ‘RANGE’ для ключа сортировки

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

latest_stream_arn

string

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

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

latest_stream_label

string

Метка времени этого потока в формате 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

Amazon Resource Name (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

Amazon Resource Name (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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/dynamodb_table_info_module.html

Spec-Zone.ru

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