Spec-Zone.ru › Ansible 2.7

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 ←
  • NUMBER
  • BINARY
Тип хеш-ключа.
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 ←
  • NUMBER
  • BINARY
Тип ключа диапазона.
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
-
    Варианты:
  • present ←
  • absent
Создать или удалить таблицу
tags
-
добавлен в 2.4
Хэш/словарь меток для добавления к новой инстанции или для запуска/остановки инстанции по метке; '{"key":"value"}' и '{"key":"value","key":"value"}'
validate_certs
boolean
добавлен в 1.5
    Варианты:
  • no
  • yes ←
При установке в "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), если учетные данные не предоставлены. См. 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
строка
success
Текущий статус таблицы.

Пример:
ACTIVE


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [предварительный просмотр]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.7/modules/dynamodb_table_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API