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

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

Обзор
Требования (для хоста, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Обзор

Создание или удаление потока Kinesis.
Изменение периода хранения данных потока Kinesis.
Изменение тегов потока Kinesis.

Требования (для хоста, на котором выполняется модуль)

python >= 2.6
boto

Параметры

параметр	обязательно	значение по умолчанию	допустимые значения	комментарии
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, если таковое имеется.
name	да	None		Имя потока 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	нет	None		Период хранения данных по умолчанию составляет 24 часа и не может быть меньше 24 часов. Период хранения может быть изменен в любой момент.
security_token (добавлен в 1.6)	нет			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
shards	нет	None		Количество фрагментов, которое вы хотите иметь в этом потоке. Это необходимо, когда state == present
state	нет	present	present absent	Создать или удалить поток Kinesis.
tags	нет			Словарь тегов ресурсов в формате: { tag1: value1, tag2: value2 } псевдонимы: resource_tags
validate_certs (добавлен в 1.5)	нет	да	да нет	Если установлено значение "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
wait	нет	True		Ожидать завершения операции перед возвратом.
wait_timeout	нет	300		Время ожидания завершения операции в секундах перед истечением времени.

Примеры

# 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

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

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

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

Примечания

Примечание

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