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 | нет | STRING |
| Тип хеш-ключа. |
| 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 | нет | STRING |
| Тип диапазонного ключа. |
| 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 security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| state | нет | present |
| Создать или удалить таблицу |
| tags (добавлен в 2.4)
| нет | Хеш/словарь тегов для добавления к новой экземпляру или для запуска/остановки экземпляра по тегу; '{"key":"value"}' и '{"key":"value","key":"value"}' | ||
| validate_certs (добавлен в 1.5)
| нет | да |
| При значении "нет", сертификаты SSL не будут проверены для boto версий >= 2.6.0. |
| wait_for_active_timeout (добавлен в 2.4)
| нет | 60 | Сколько времени ожидать, прежде чем прекратить ожидание, в секундах. используется только при установленных тегах | |
| write_capacity | нет | 1 | Пропускная способность записи (единицы) для выделения. |
Примеры
# 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 | Текущий статус таблицы. | успех | строка | ACTIVE |
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета
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
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантированно будет иметь обратную совместимость.
Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Информацию о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/dynamodb_table_module.html