kinesis_stream - Управление потоком Kinesis.

Новое в версии 2.2.

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Описание

Создание или удаление потока Kinesis.
Обновление периода хранения данных в потоке Kinesis.
Обновление тегов потока Kinesis.
Включение/выключение шифрования на стороне сервера для потока Kinesis.

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

boto
boto3
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, если она задана.
encryption_state (добавлено в 2.5)	Варианты: enabled disabled	Включить или отключить шифрование в потоке Kinesis.
encryption_type (добавлено в 2.5)	По умолчанию: KMS	Тип шифрования.
key_id (добавлено в 2.5)	По умолчанию: None	GUID или псевдоним для ключа KMS.
name требуется	По умолчанию: None	Имя потока Kinesis, которое вы управляете.
profile (добавлено в 1.6)	По умолчанию: None	Использует профиль boto. Работает только с boto >= 2.24.0.
region		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она задана. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
retention_period	По умолчанию: None	Период хранения по умолчанию составляет 24 часа и не может быть меньше 24 часов. Период хранения может быть изменен в любой момент.
security_token (добавлено в 1.6)	По умолчанию: None	Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
shards	По умолчанию: None	Количество фрагментов, которое вы хотите иметь в этом потоке. Это требуется, когда состояние == present
state	Варианты: present ← absent	Создать или удалить поток Kinesis.
tags	По умолчанию: None	Словарь тегов ресурса в формате: { tag1: value1, tag2: value2 }. Псевдонимы: resource_tags
validate_certs (добавлено в 1.5)	Варианты: no yes ←	При значении "no" сертификаты SSL не будут проверены для версий boto >= 2.6.0.
wait	По умолчанию: yes	Ожидание завершения операции перед возвратом.
wait_timeout	По умолчанию: 300	Сколько секунд ожидать завершения операции перед истечением времени ожидания.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Basic creation example:
- name: Set up Kinesis Stream with 10 shards and wait for the stream to become ACTIVE
  kinesis_stream:
    name: test-stream
    shards: 10
    wait: yes
    wait_timeout: 600
  register: test_stream

# Basic creation example with tags:
- name: Set up Kinesis Stream with 10 shards, tag the environment, and wait for the stream to become ACTIVE
  kinesis_stream:
    name: test-stream
    shards: 10
    tags:
      Env: development
    wait: yes
    wait_timeout: 600
  register: test_stream

# Basic creation example with tags and increase the retention period from the default 24 hours to 48 hours:
- name: Set up Kinesis Stream with 10 shards, tag the environment, increase the retention period and wait for the stream to become ACTIVE
  kinesis_stream:
    name: test-stream
    retention_period: 48
    shards: 10
    tags:
      Env: development
    wait: yes
    wait_timeout: 600
  register: test_stream

# Basic delete example:
- name: Delete Kinesis Stream test-stream and wait for it to finish deleting.
  kinesis_stream:
    name: test-stream
    state: absent
    wait: yes
    wait_timeout: 600
  register: test_stream

# Basic enable encryption example:
- name: Encrypt Kinesis Stream test-stream.
  kinesis_stream:
    name: test-stream
    state: present
    encryption_state: enabled
    encryption_type: KMS
    key_id: alias/aws/kinesis
    wait: yes
    wait_timeout: 600
  register: test_stream

# Basic disable encryption example:
- name: Encrypt Kinesis Stream test-stream.
  kinesis_stream:
    name: test-stream
    state: present
    encryption_state: disabled
    encryption_type: KMS
    key_id: alias/aws/kinesis
    wait: yes
    wait_timeout: 600
  register: test_stream

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
retention_period_hours int	при состоянии == present.	Количество часов, в течение которых сообщения будут храниться в потоке Kinesis. Пример: 24
stream_arn строка	при состоянии == present.	Amazon ресурсный идентификатор Пример: arn:aws:kinesis:east-side:123456789:stream/test-stream
stream_name строка	при состоянии == present.	Имя потока Kinesis. Пример: test-stream
stream_status строка	при состоянии == present.	Текущее состояние потока Kinesis. Пример: ACTIVE
tags dict	при состоянии == present.	Словарь, содержащий все теги, связанные с потоком Kinesis. Пример: {'Name': 'Splunk', 'Env': 'development'}

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

Allen Sanabria (@linuxdynasty)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.

© 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/kinesis_stream_module.html