salt.states.boto_sqs
Manage SQS Queues
New in version 2014.7.0.
Create and destroy SQS queues. Be aware that this interacts with Amazon's services, and so may incur charges.
This module uses boto
, which can be installed via package, or pip.
This module accepts explicit SQS 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:
sqs.keyid: GKTADJGHEIQSXMKKRBJ08H sqs.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
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
myqueue: boto_sqs.present: - region: us-east-1 - keyid: GKTADJGHEIQSXMKKRBJ08H - key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs - attributes: ReceiveMessageWaitTimeSeconds: 20 # Using a profile from pillars myqueue: boto_sqs.present: - region: us-east-1 - profile: mysqsprofile # Passing in a profile myqueue: boto_sqs.present: - region: us-east-1 - profile: keyid: GKTADJGHEIQSXMKKRBJ08H key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
-
Ensure the named sqs queue is deleted.
- name
-
Name of the SQS queue.
- region
-
Region to connect to.
- key
-
Secret key to be used.
- keyid
-
Access key to be used.
- profile
-
A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.
salt.states.boto_sqs.absent(name, region=None, key=None, keyid=None, profile=None)
-
Ensure the SQS queue exists.
- name
-
Name of the SQS queue.
- attributes
-
A dict of key/value SQS attributes.
- region
-
Region to connect to.
- key
-
Secret key to be used.
- keyid
-
Access key to be used.
- profile
-
A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.
salt.states.boto_sqs.present(name, attributes=None, region=None, key=None, keyid=None, profile=None)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/states/all/salt.states.boto_sqs.html