dynamodb_table - Создание, обновление или удаление таблиц AWS Dynamo DB.
Новая версия в версии 2.0.
Обзор
- Создание или удаление таблиц 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 | |
| ec2_url | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. | |
| hash_key_name | Имя ключа хеширования. Требуется, когда state=present. | |
| hash_key_type |
| Тип ключа хеширования. |
| indexes (добавлено в 2.1) | Значение по умолчанию: [] | Список словарей, описывающих индексы, которые нужно добавить в таблицу. Глобальные индексы могут быть обновлены. Местные индексы не поддерживают обновления или не имеют пропускной способности. Обязательные параметры: ['name', 'type', 'hash_key_name'] Допустимые типы: ['all', 'global_all', 'global_include', 'global_keys_only', 'include', 'keys_only'] Другие параметры: ['hash_key_type', 'range_key_name', 'range_key_type', 'includes', 'read_capacity', 'write_capacity'] |
| name обязательно | Имя таблицы. | |
| profile (добавлено в 1.6) | Использует профиль 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 (добавлено в 1.6) | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state |
| Создать или удалить таблицу |
| tags (добавлено в 2.4) | Словарь тегов для добавления к новой таблице или для запуска/остановки экземпляра по тегу; '{"ключ":"значение"}' и '{"ключ":"значение","ключ":"значение"}' | |
| validate_certs bool (добавлено в 1.5) |
| Если установлено "no", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 строка | success | Текущее состояние таблицы. Пример: ACTIVE |
Статус
Этот модуль помечен как превью, что означает, что интерфейс не гарантируется как обратная совместимость.
Обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/dynamodb_table_module.html