sns - Amazon Simple Notification Service

Warning

Do not commit your credentials to a public repo!

If you have AWS credentials configured elsewhere (e.g. in ~/.aws/credentials), or in the environment, this will use those and you do not need to specify credentials in your configuration file.

As a best practice, use an IAM User/Role which is only allowed to access the resources in use.

Note that not all regions with SNS also support sending SMS.

topic
Type:

string

Required:

yes, if number is not given

the ARN of the SNS topic to publish to. Specify this, or number, but not both.

number
Type:

string

Required:

yes, if topic is not given

the phone number to SMS. Give the number as country code then number, without a + or other international access code. For example, 447777123456 for a UK mobile. Specify this, or topic, but not both.

sender_id
Type:

string

Required:

no

Default:

SmplMntr

the sender ID to use when sending SMSes. See the SenderID documentation in the SNS docs: https://docs.aws.amazon.com/sns/latest/dg/sms_sending-overview.html#sms_publish-to-phone

aws_region
Type:

string

Required:

false

the AWS region to use (e.g. eu-west-1)

aws_access_key
Type:

string

Required:

false

the AWS access key to use

aws_secret_access_key
Type:

string

Required:

false

the AWS secret access key to use