Try SpotterManage a Kinesis Stream.
| "added in version" 2.2 of ansible.builtin"
Authors: Allen Sanabria (@linuxdynasty)
preview | supported by community
pipInstall with pip install ansible==2.4.3.0.post1
Create or Delete a Kinesis Stream.
Update the retention period of a Kinesis Stream.
Update Tags on a Kinesis Stream.
# 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
name:
default: None
description:
- The name of the Kinesis Stream you are managing.
required: true
tags:
aliases:
- resource_tags
default: null
description:
- 'A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }.'
required: false
wait:
default: true
description:
- Wait for operation to complete before returning.
required: false
state:
choices:
- present
- absent
default: present
description:
- Create or Delete the Kinesis Stream.
required: false
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
shards:
default: None
description:
- The number of shards you want to have with this stream.
- This is required when state == present
required: false
profile:
aliases:
- aws_profile
description:
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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.
type: str
wait_timeout:
default: 300
description:
- How many seconds to wait for an operation to complete before timing out.
required: false
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- The I(aws_secret_key) and I(profile) options are mutually exclusive.
type: str
security_token:
aliases:
- aws_session_token
- session_token
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
retention_period:
default: None
description:
- 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.
required: false
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
retention_period_hours:
description: Number of hours messages will be kept for a Kinesis Stream.
returned: when state == present.
sample: 24
type: int
stream_arn:
description: The amazon resource identifier
returned: when state == present.
sample: arn:aws:kinesis:east-side:123456789:stream/test-stream
type: string
stream_name:
description: The name of the Kinesis Stream.
returned: when state == present.
sample: test-stream
type: string
stream_status:
description: The current state of the Kinesis Stream.
returned: when state == present.
sample: ACTIVE
type: string
tags:
description: Dictionary containing all the tags associated with the Kinesis stream.
returned: when state == present.
sample:
Env: development
Name: Splunk
type: dict