New in version 2017.7.0.
Create and destroy Kinesis streams. Be aware that this interacts with Amazon's services, and so may incur charges.
This module uses boto3
, which can be installed via package, or pip.
This module accepts explicit Kinesis credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More information available here.
If IAM roles are not used you need to specify them either in a pillar file or in the minion's config file:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
It's also possible to specify key
, keyid
and region
via a
profile, either passed in as a dict, or as a string to pull from
pillars or minion config:
myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
Ensure Kinesis stream does not exist:
boto_kinesis.absent:
- name: new_stream
- keyid: GKTADJGHEIQSXMKKRBJ08H
- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
- region: us-east-1
Ensure Kinesis stream exists:
boto_kinesis.present:
- name: new_stream
- retention_hours: 168
- enhanced_monitoring: ['ALL']
- num_shards: 2
- keyid: GKTADJGHEIQSXMKKRBJ08H
- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
- region: us-east-1
salt.states.boto_kinesis.
absent
(name, region=None, key=None, keyid=None, profile=None)¶Delete the kinesis stream, if it exists.
salt.states.boto_kinesis.
present
(name, retention_hours=None, enhanced_monitoring=None, num_shards=None, do_reshard=True, region=None, key=None, keyid=None, profile=None)¶Ensure the kinesis stream is properly configured and scaled.