Skip to content

Resource: awsPinpointSmsChannel

Provides a Pinpoint SMS Channel resource.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsPinpointAppApp = new aws.pinpointApp.PinpointApp(this, "app", {});
new aws.pinpointSmsChannel.PinpointSmsChannel(this, "sms", {
  applicationId: awsPinpointAppApp.applicationId,
});

Argument Reference

The following arguments are supported:

  • applicationId - (Required) The application ID.
  • enabled - (Optional) Whether the channel is enabled or disabled. Defaults to true.
  • senderId - (Optional) Sender identifier of your messages.
  • shortCode - (Optional) The Short Code registered with the phone provider.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • promotionalMessagesPerSecond - Promotional messages per second that can be sent.
  • transactionalMessagesPerSecond - Transactional messages per second that can be sent.

Import

Pinpoint SMS Channel can be imported using the applicationId, e.g.,

$ terraform import aws_pinpoint_sms_channel.sms application-id