dynamodb_table – Создание, обновление или удаление таблиц AWS Dynamo DB
Обзор
- Создание или удаление таблиц 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. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип добавлен в 2.8 |
| Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", выполняемых во время задачи, выводящих набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время исполнения плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если она задана. | |
| hash_key_name - | Имя ключа хеширования. Требуется, когда state=present. | |
| hash_key_type - |
| Тип ключа хеширования. |
| indexes - | Значение по умолчанию: [] | Список словарей, описывающих индексы для добавления в таблицу. Глобальные индексы могут быть обновлены. Локальные индексы не поддерживают обновление или пропускную способность. Необходимые параметры: ['name', 'type', 'hash_key_name'] Допустимые типы: ['все', 'глобальные_все', 'глобальные_включая', 'только_глобальные_ключи', 'включая', 'только_ключи'] Другие параметры: ['hash_key_type', 'range_key_name', 'range_key_type', 'включает', 'пропускная_способность_чтения', 'пропускная_способность_записи'] |
| name - / обязательно | Имя таблицы. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| 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. псевдонимы: access_token | |
| state - |
| Создать или удалить таблицу |
| tags - добавлен в 2.4 | Словарь/массив тегов для добавления к новой таблице или для запуска/остановки таблицы по тегу; '{"ключ":"значение"}' и '{"ключ":"значение","ключ":"значение"}' | |
| validate_certs логический тип |
| При установке "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| wait_for_active_timeout - добавлен в 2.4 | Значение по умолчанию: 60 | Сколько времени ждать, пока ожидание не завершится, в секундах. Используется только при установке тегов. |
| write_capacity - | Значение по умолчанию: 1 | Пропускная способность записи (единицы) для выделения. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания AWS-региона, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# Create dynamo table with hash and range primary key
- 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
# Update capacity on existing dynamo table
- dynamodb_table:
name: my-table
region: us-east-1
read_capacity: 10
write_capacity: 10
# set index on existing dynamo table
- 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
# Delete dynamo table
- dynamodb_table:
name: my-table
region: us-east-1
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| table_status строка | успех | Текущее состояние таблицы. Пример: АКТИВНО |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/dynamodb_table_module.html