SMS (using AWS SNS)

SMS service provided by Amazon Simple Notification Service (SNS)

Provisioning

Request Parameters

region string - The region of the SNS service. Default: ${config("aws.default_region")}.
- The value must be one of: [ap-east-1 ap-northeast-1 ap-northeast-2 ap-northeast-3 ap-south-1 ap-southeast-1 ap-southeast-2 ca-central-1 cn-north-1 cn-northwest-1 eu-central-1 eu-north-1 eu-west-1 eu-west-2 eu-west-3 me-south-1 sa-east-1 us-east-1 us-east-2 us-gov-east-1 us-gov-west-1 us-west-1 us-west-2].
sender_id __ - Default Sender ID. Not currently used in US. Default: Notify-Gov.
monthly_spend_limit number - SMS budget limit in USD. Support request must be made before raising above 1 Default: 1.

Request Parameters

source_ips array - IP Ranges that requests to SNS must come from Default: [52.222.122.97/32 52.222.123.172/32].

Response Parameters

region string - AWS region for the SNS instance
instructions string - Next steps that must be taken manually
aws_access_key_id string - Required The AWS access key to send SMS via API
aws_secret_access_key string - Required The AWS secret access key to send SMS via API

The following plans are built-in to the Cloud Service Broker and may be overridden or disabled by the broker administrator.

base
- Plan ID: b1f26b91-01b4-4d73-8bc6-a213cadaccb6.
- Description: Provision credentials to use for sending transational SMS messages from your application.
- This plan doesn't override user variables on provision.
- This plan doesn't override user variables on bind.

Create SMS settings and bind a user in the us-west-2 region. Uses plan: b1f26b91-01b4-4d73-8bc6-a213cadaccb6.

Provision

{
    "region": "us-west-2"
}

Bind

{}

Cloud Foundry Example

$ cf create-service ttsnotify-sms base my-ttsnotify-sms-example -c `{"region":"us-west-2"}`
$ cf bind-service my-app my-ttsnotify-sms-example -c `{}`