SmsChannel

Provides a Pinpoint SMS Channel resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var app = new Aws.Pinpoint.App("app", new Aws.Pinpoint.AppArgs
        {
        });
        var sms = new Aws.Pinpoint.SmsChannel("sms", new Aws.Pinpoint.SmsChannelArgs
        {
            ApplicationId = app.ApplicationId,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/pinpoint"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        app, err := pinpoint.NewApp(ctx, "app", nil)
        if err != nil {
            return err
        }
        _, err = pinpoint.NewSmsChannel(ctx, "sms", &pinpoint.SmsChannelArgs{
            ApplicationId: app.ApplicationId,
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
sms = aws.pinpoint.SmsChannel("sms", application_id=app.application_id)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const app = new aws.pinpoint.App("app", {});
const sms = new aws.pinpoint.SmsChannel("sms", {
    applicationId: app.applicationId,
});

Create a SmsChannel Resource

new SmsChannel(name: string, args: SmsChannelArgs, opts?: CustomResourceOptions);

def SmsChannel(resource_name, opts=None, application_id=None, enabled=None, sender_id=None, short_code=None, __props__=None);

func NewSmsChannel(ctx *Context, name string, args SmsChannelArgs, opts ...ResourceOption) (*SmsChannel, error)

public SmsChannel(string name, SmsChannelArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args SmsChannelArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SmsChannelArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SmsChannelArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

SmsChannel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The SmsChannel resource accepts the following input properties:

ApplicationId string: The application ID.
Enabled bool: Whether the channel is enabled or disabled. Defaults to true.
SenderId string: Sender identifier of your messages.
ShortCode string: The Short Code registered with the phone provider.

ApplicationId string: The application ID.
Enabled bool: Whether the channel is enabled or disabled. Defaults to true.
SenderId string: Sender identifier of your messages.
ShortCode string: The Short Code registered with the phone provider.

applicationId string: The application ID.
enabled boolean: Whether the channel is enabled or disabled. Defaults to true.
senderId string: Sender identifier of your messages.
shortCode string: The Short Code registered with the phone provider.

application_id str: The application ID.
enabled bool: Whether the channel is enabled or disabled. Defaults to true.
sender_id str: Sender identifier of your messages.
short_code str: The Short Code registered with the phone provider.

Outputs

All input properties are implicitly available as output properties. Additionally, the SmsChannel resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
PromotionalMessagesPerSecond int: Promotional messages per second that can be sent.
TransactionalMessagesPerSecond int: Transactional messages per second that can be sent.

Id string: The provider-assigned unique ID for this managed resource.
PromotionalMessagesPerSecond int: Promotional messages per second that can be sent.
TransactionalMessagesPerSecond int: Transactional messages per second that can be sent.

id string: The provider-assigned unique ID for this managed resource.
promotionalMessagesPerSecond number: Promotional messages per second that can be sent.
transactionalMessagesPerSecond number: Transactional messages per second that can be sent.

id str: The provider-assigned unique ID for this managed resource.
promotional_messages_per_second float: Promotional messages per second that can be sent.
transactional_messages_per_second float: Transactional messages per second that can be sent.

Look up an Existing SmsChannel Resource

Get an existing SmsChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SmsChannelState, opts?: CustomResourceOptions): SmsChannel

static get(resource_name, id, opts=None, application_id=None, enabled=None, promotional_messages_per_second=None, sender_id=None, short_code=None, transactional_messages_per_second=None, __props__=None);

func GetSmsChannel(ctx *Context, name string, id IDInput, state *SmsChannelState, opts ...ResourceOption) (*SmsChannel, error)

public static SmsChannel Get(string name, Input<string> id, SmsChannelState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApplicationId string: The application ID.
Enabled bool: Whether the channel is enabled or disabled. Defaults to true.
PromotionalMessagesPerSecond int: Promotional messages per second that can be sent.
SenderId string: Sender identifier of your messages.
ShortCode string: The Short Code registered with the phone provider.
TransactionalMessagesPerSecond int: Transactional messages per second that can be sent.

ApplicationId string: The application ID.
Enabled bool: Whether the channel is enabled or disabled. Defaults to true.
PromotionalMessagesPerSecond int: Promotional messages per second that can be sent.
SenderId string: Sender identifier of your messages.
ShortCode string: The Short Code registered with the phone provider.
TransactionalMessagesPerSecond int: Transactional messages per second that can be sent.

applicationId string: The application ID.
enabled boolean: Whether the channel is enabled or disabled. Defaults to true.
promotionalMessagesPerSecond number: Promotional messages per second that can be sent.
senderId string: Sender identifier of your messages.
shortCode string: The Short Code registered with the phone provider.
transactionalMessagesPerSecond number: Transactional messages per second that can be sent.

application_id str: The application ID.
enabled bool: Whether the channel is enabled or disabled. Defaults to true.
promotional_messages_per_second float: Promotional messages per second that can be sent.
sender_id str: Sender identifier of your messages.
short_code str: The Short Code registered with the phone provider.
transactional_messages_per_second float: Transactional messages per second that can be sent.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud