# salt.states.boto3_sns

## Manage SNS Topics

Create and destroy SNS topics. 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 AWS 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:

    sns.keyid: GKTADJGHEIQSXMKKRBJ08H
    sns.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

    mytopic:
        boto3_sns.topic_present:
            - region: us-east-1
            - keyid: GKTADJGHEIQSXMKKRBJ08H
            - key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

### Using a profile from pillars

    mytopic:
        boto3_sns.topic_present:
            - region: us-east-1
            - profile: mysnsprofile

### Passing in a profile

    mytopic:
        boto3_sns.topic_present:
            - region: us-east-1
            - profile:
                keyid: GKTADJGHEIQSXMKKRBJ08H
                key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

salt.states.boto3_sns.topic_absent(name, unsubscribe=False, region=None, key=None, keyid=None, profile=None)

  Ensure the named sns topic is deleted.

  name

    Name of the SNS topic.

  unsubscribe

    If True, unsubscribe all subcriptions to the SNS topic before deleting the SNS topic

  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.boto3_sns.topic_present(name, subscriptions=None, attributes=None, region=None, key=None, keyid=None, profile=None)

  Ensure the SNS topic exists.

  name

    Name of the SNS topic.

  subscriptions

    List of SNS subscriptions.

    Each subscription is a dictionary with a protocol and endpoint key:

        subscriptions:
        - Protocol: https
          Endpoint: https://www.example.com/sns-endpoint
        - Protocol: sqs
          Endpoint: arn:aws:sqs:us-west-2:123456789012:MyQueue

  attributes

    Dictionary of attributes to set on the SNS topic Valid attribute keys are:

    > - Policy: the JSON serialization of the topic's access control policy

    > - DisplayName: the human-readable name used in the "From" field for notifications

    >     to email and email-json endpoints

    > - DeliveryPolicy: the JSON serialization of the topic's delivery policy

  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.