kinesis_stream – Manage a Kinesis Stream.

New in version 2.2.

Synopsis

  • Create or Delete a Kinesis Stream.
  • Update the retention period of a Kinesis Stream.
  • Update Tags on a Kinesis Stream.
  • Enable/disable server side encryption on a Kinesis Stream.

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
-
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

aliases: ec2_access_key, access_key
aws_secret_key
-
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

aliases: ec2_secret_key, secret_key
ec2_url
-
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
encryption_state
-
added in 2.5
    Choices:
  • enabled
  • disabled
Enable or Disable encryption on the Kinesis Stream.
encryption_type
-
added in 2.5
 Default:
"KMS"
The type of encryption.
key_id
-
added in 2.5
The GUID or alias for the KMS key.
name
- / required
The name of the Kinesis Stream you are managing.
profile
-
added in 1.6
Uses a boto profile. Only works with boto >= 2.24.0.
region
-
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
retention_period
-
The default retention period is 24 hours and can not be less than 24 hours.
The retention period can be modified during any point in time.
security_token
-
added in 1.6
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

aliases: access_token
shards
-
The number of shards you want to have with this stream.
This is required when state == present
state
-
    Choices:
  • present ←
  • absent
Create or Delete the Kinesis Stream.
tags
-
A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }.

aliases: resource_tags
validate_certs
boolean
added in 1.5
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait
-
Default:
"yes"
Wait for operation to complete before returning.
wait_timeout
-
Default:
300
How many seconds to wait for an operation to complete before timing out.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
retention_period_hours
integer
 when state == present.
Number of hours messages will be kept for a Kinesis Stream.

Sample:
24
stream_arn
string
 when state == present.
The amazon resource identifier

Sample:
arn:aws:kinesis:east-side:123456789:stream/test-stream
stream_name
string
 when state == present.
The name of the Kinesis Stream.

Sample:
test-stream
stream_status
string
 when state == present.
The current state of the Kinesis Stream.

Sample:
ACTIVE
tags
dictionary
 when state == present.
Dictionary containing all the tags associated with the Kinesis stream.

Sample:
{'Name': 'Splunk', 'Env': 'development'}


Status

Authors

  • Allen Sanabria (@linuxdynasty)

Hint

If you notice any issues in this documentation you can edit this document to improve it.