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 | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если таковая имеется. |
| hash_key_name | Значение по умолчанию: None | Имя хеш-ключа. Требуется, когда 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) | Значение по умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| range_key_name | Значение по умолчанию: None | Имя диапазонного ключа. |
| 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) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| state |
| Создать или удалить таблицу |
| tags (добавлен в 2.4) | Значение по умолчанию: None | Словарь тегов для добавления к новой таблице или для запуска/остановки экземпляра по тегу; '{"key":"value"}' и '{"key":"value","key":"value"}' |
| validate_certs (добавлен в 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 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/dynamodb_table_module.html