community.aws.dynamodb_table – Создание, обновление или удаление таблиц AWS Dynamo DB
Примечание
Этот плагин входит в состав коллекции community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в playbook, укажите: community.aws.dynamodb_table.
Новое в версии 1.0.0: из community.aws
Обзор
- Создание или удаление таблиц AWS Dynamo DB.
- Возможность обновления пропускной способности предоставленной для существующих таблиц.
- Возвращает состояние указанной таблицы.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- boto
- boto >= 2.37.0
- boto3 >= 1.4.4 (для тегов)
- 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'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации 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 | ||
| debug_botocore_endpoint_logs логический |
| Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения playbook. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. | |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | ||
| hash_key_name строка | Имя хеш-ключа. Требуется при state=present. | ||
| hash_key_type строка |
| Тип хеш-ключа. | |
| indexes список / элементы=словарь | По умолчанию: [] | список словарей, описывающих индексы для добавления в таблицу. глобальные индексы могут быть обновлены. локальные индексы не поддерживают обновлений или имеют пропускную способность. обязательные параметры: ['name', 'type', 'hash_key_name'] дополнительные параметры: ['hash_key_type', 'range_key_name', 'range_key_type', 'includes', 'read_capacity', 'write_capacity'] | |
| hash_key_name строка / обязательно | Имя ключа, основанного на хеше. | ||
| hash_key_type строка | Тип ключа, основанного на хеше. | ||
| includes список / элементы=строка | Список полей для включения при использовании global_include или include индексов. | ||
| name строка / обязательно | Имя индекса. | ||
| range_key_name строка | Имя ключа диапазона. | ||
| range_key_type строка | Тип ключа диапазона. | ||
| read_capacity целое число | Пропускная способность чтения (единицы) для резервирования индекса. | ||
| type строка / обязательно | Тип индекса. Допустимые типы: all, global_all, global_include, global_keys_only, include, keys_only | ||
| write_capacity целое число | Пропускная способность записи (единицы) для резервирования индекса. | ||
| name строка / обязательно | Имя таблицы. | ||
| 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 | ||
| range_key_name строка | Имя ключа диапазона. | ||
| range_key_type строка |
| Тип ключа диапазона. | |
| read_capacity целое число | По умолчанию: 1 | Пропускная способность чтения (единицы) для резервирования. | |
| 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 | ||
| state строка |
| Создать или удалить таблицу. | |
| tags словарь | Словарь тегов для добавления к новому экземпляру или для запуска/остановки экземпляра по тегу. Например: {"key":"value"} и {"key":"value","key2":"value2"}
| ||
| validate_certs логический |
| Если значение «нет», SSL-сертификаты для boto версий >= 2.6.0 не будут проверяться. | |
| wait_for_active_timeout целое число | По умолчанию: 60 | Время ожидания, прежде чем ожидание прекратится, в секундах. Используется только при указании тегов. | |
| write_capacity целое число | По умолчанию: 1 | Пропускная способность записи (единицы) для резервирования. | |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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: Create dynamo table with hash and range primary key
community.aws.dynamodb_table:
name: my-table
region: us-east-1
hash_key_name: id
hash_key_type: STRING
range_key_name: create_time
range_key_type: NUMBER
read_capacity: 2
write_capacity: 2
tags:
tag_name: tag_value
- name: Update capacity on existing dynamo table
community.aws.dynamodb_table:
name: my-table
region: us-east-1
read_capacity: 10
write_capacity: 10
- name: set index on existing dynamo table
community.aws.dynamodb_table:
name: my-table
region: us-east-1
indexes:
- name: NamedIndex
type: global_include
hash_key_name: id
range_key_name: create_time
includes:
- other_field
- other_field2
read_capacity: 10
write_capacity: 10
- name: Delete dynamo table
community.aws.dynamodb_table:
name: my-table
region: us-east-1
state: absent
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| table_status строка | success | Текущий статус таблицы. Пример: ACTIVE |
Авторы
- Alan Loi (@loia)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/dynamodb_table_module.html
