salt.modules.boto_sqs

Connection module for Amazon SQS

New in version 2014.7.0.

configuration:

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 at:

http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html

If IAM roles are not used you need to specify them either in a pillar or in the minion's config file:

sqs.keyid: GKTADJGHEIQSXMKKRBJ08H
sqs.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

A region may also be specified in the configuration:

sqs.region: us-east-1

If a region is not specified, the default is us-east-1.

It's also possible to specify key, keyid and region via a profile, either as a passed in dict, or as a string to pull from pillars or minion config:

myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us-east-1
depends:

boto3

salt.modules.boto_sqs.create(name, attributes=None, region=None, key=None, keyid=None, profile=None)

Create an SQS queue.

CLI Example:

salt myminion boto_sqs.create myqueue region=us-east-1
salt.modules.boto_sqs.delete(name, region=None, key=None, keyid=None, profile=None)

Delete an SQS queue.

CLI Example:

salt myminion boto_sqs.delete myqueue region=us-east-1
salt.modules.boto_sqs.exists(name, region=None, key=None, keyid=None, profile=None)

Check to see if a queue exists.

CLI Example:

salt myminion boto_sqs.exists myqueue region=us-east-1
salt.modules.boto_sqs.get_attributes(name, region=None, key=None, keyid=None, profile=None)

Return attributes currently set on an SQS queue.

CLI Example:

salt myminion boto_sqs.get_attributes myqueue
salt.modules.boto_sqs.list(prefix='', region=None, key=None, keyid=None, profile=None)

Return a list of the names of all visible queues.

New in version 2016.11.0.

CLI Example:

salt myminion boto_sqs.list region=us-east-1
salt.modules.boto_sqs.set_attributes(name, attributes, region=None, key=None, keyid=None, profile=None)

Set attributes on an SQS queue.

CLI Example:

salt myminion boto_sqs.set_attributes myqueue '{ReceiveMessageWaitTimeSeconds: 20}' region=us-east-1