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

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

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

Описание

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

Требования

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

boto
boto3
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, если она есть.
encryption_state - добавлено в 2.5	Варианты: enabled disabled	Включить или выключить шифрование в потоке Kinesis.
encryption_type - добавлено в 2.5	По умолчанию: "KMS"	Тип шифрования.
key_id - добавлено в 2.5		GUID или псевдоним для ключа KMS.
name - / обязательно		Имя потока Kinesis, которое вы управляете.
profile - добавлено в 1.6		Использует профиль 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 -		Период хранения по умолчанию составляет 24 часа и не может быть меньше 24 часов. Период хранения может быть изменён в любой момент.
security_token - добавлено в 1.6		AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
shards -		Количество фрагментов, которое вы хотите иметь в этом потоке. Это требуется, когда state == present
state -	Варианты: present ← absent	Создать или удалить поток Kinesis.
tags -		Словарь тегов ресурсов в формате: { tag1: значение1, tag2: значение2 } псевдонимы: resource_tags
validate_certs boolean добавлено в 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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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 целое число	при state == present.	Количество часов, в течение которых сообщения будут храниться в потоке Kinesis. Пример: 24
stream_arn строка	при state == present.	Идентификатор ресурса Amazon. Пример: arn:aws:kinesis:east-side:123456789:stream/test-stream
stream_name строка	при state == present.	Имя потока Kinesis. Пример: test-stream
stream_status строка	при state == present.	Текущее состояние потока Kinesis. Пример: ACTIVE
tags словарь	при state == present.	Словарь, содержащий все теги, связанные с потоком Kinesis. Пример: {'Имя': 'Splunk', 'Env': 'development'}

Статус

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

Авторы

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