Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. pinpoint
  5. SmsChannel

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.pinpoint.SmsChannel

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Use the aws.pinpoint.SmsChannel resource to manage Pinpoint SMS Channels.

    Example Usage

    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});

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/pinpoint"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var app = new Aws.Pinpoint.App("app");

    var sms = new Aws.Pinpoint.SmsChannel("sms", new()
    {
        ApplicationId = app.ApplicationId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.App;
import com.pulumi.aws.pinpoint.SmsChannel;
import com.pulumi.aws.pinpoint.SmsChannelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var app = new App("app");

        var sms = new SmsChannel("sms", SmsChannelArgs.builder()
            .applicationId(app.applicationId())
            .build());

    }
}

    resources:
  sms:
    type: aws:pinpoint:SmsChannel
    properties:
      applicationId: ${app.applicationId}
  app:
    type: aws:pinpoint:App

    Create SmsChannel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SmsChannel(name: string, args: SmsChannelArgs, opts?: CustomResourceOptions);
    @overload
def SmsChannel(resource_name: str,
               args: SmsChannelArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def SmsChannel(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               application_id: Optional[str] = None,
               enabled: Optional[bool] = None,
               sender_id: Optional[str] = None,
               short_code: Optional[str] = None)
    func NewSmsChannel(ctx *Context, name string, args SmsChannelArgs, opts ...ResourceOption) (*SmsChannel, error)
    public SmsChannel(string name, SmsChannelArgs args, CustomResourceOptions? opts = null)
    public SmsChannel(String name, SmsChannelArgs args)
public SmsChannel(String name, SmsChannelArgs args, CustomResourceOptions options)

    type: aws:pinpoint:SmsChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args SmsChannelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args SmsChannelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var smsChannelResource = new Aws.Pinpoint.SmsChannel("smsChannelResource", new()
{
    ApplicationId = "string",
    Enabled = false,
    SenderId = "string",
    ShortCode = "string",
});

    example, err := pinpoint.NewSmsChannel(ctx, "smsChannelResource", &pinpoint.SmsChannelArgs{
	ApplicationId: pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	SenderId:      pulumi.String("string"),
	ShortCode:     pulumi.String("string"),
})

    var smsChannelResource = new SmsChannel("smsChannelResource", SmsChannelArgs.builder()
    .applicationId("string")
    .enabled(false)
    .senderId("string")
    .shortCode("string")
    .build());

    sms_channel_resource = aws.pinpoint.SmsChannel("smsChannelResource",
    application_id="string",
    enabled=False,
    sender_id="string",
    short_code="string")

    const smsChannelResource = new aws.pinpoint.SmsChannel("smsChannelResource", {
    applicationId: "string",
    enabled: false,
    senderId: "string",
    shortCode: "string",
});

    type: aws:pinpoint:SmsChannel
properties:
    applicationId: string
    enabled: false
    senderId: string
    shortCode: string

    SmsChannel Resource Properties

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

    Inputs

    The SmsChannel resource accepts the following input properties:

    ApplicationId string
    ID of the application.
    Enabled bool
    Whether the channel is enabled or disabled. By default, it is set to true.
    SenderId string
    Identifier of the sender for your messages.
    ShortCode string
    Short Code registered with the phone provider.
    ApplicationId string
    ID of the application.
    Enabled bool
    Whether the channel is enabled or disabled. By default, it is set to true.
    SenderId string
    Identifier of the sender for your messages.
    ShortCode string
    Short Code registered with the phone provider.
    applicationId String
    ID of the application.
    enabled Boolean
    Whether the channel is enabled or disabled. By default, it is set to true.
    senderId String
    Identifier of the sender for your messages.
    shortCode String
    Short Code registered with the phone provider.
    applicationId string
    ID of the application.
    enabled boolean
    Whether the channel is enabled or disabled. By default, it is set to true.
    senderId string
    Identifier of the sender for your messages.
    shortCode string
    Short Code registered with the phone provider.
    application_id str
    ID of the application.
    enabled bool
    Whether the channel is enabled or disabled. By default, it is set to true.
    sender_id str
    Identifier of the sender for your messages.
    short_code str
    Short Code registered with the phone provider.
    applicationId String
    ID of the application.
    enabled Boolean
    Whether the channel is enabled or disabled. By default, it is set to true.
    senderId String
    Identifier of the sender for your messages.
    shortCode String
    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
    Maximum number of promotional messages that can be sent per second.
    TransactionalMessagesPerSecond int
    Maximum number of transactional messages per second that can be sent.
    Id string
    The provider-assigned unique ID for this managed resource.
    PromotionalMessagesPerSecond int
    Maximum number of promotional messages that can be sent per second.
    TransactionalMessagesPerSecond int
    Maximum number of transactional messages per second that can be sent.
    id String
    The provider-assigned unique ID for this managed resource.
    promotionalMessagesPerSecond Integer
    Maximum number of promotional messages that can be sent per second.
    transactionalMessagesPerSecond Integer
    Maximum number of transactional messages per second that can be sent.
    id string
    The provider-assigned unique ID for this managed resource.
    promotionalMessagesPerSecond number
    Maximum number of promotional messages that can be sent per second.
    transactionalMessagesPerSecond number
    Maximum number of transactional messages per second that can be sent.
    id str
    The provider-assigned unique ID for this managed resource.
    promotional_messages_per_second int
    Maximum number of promotional messages that can be sent per second.
    transactional_messages_per_second int
    Maximum number of transactional messages per second that can be sent.
    id String
    The provider-assigned unique ID for this managed resource.
    promotionalMessagesPerSecond Number
    Maximum number of promotional messages that can be sent per second.
    transactionalMessagesPerSecond Number
    Maximum number of transactional messages per second that can be sent.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        promotional_messages_per_second: Optional[int] = None,
        sender_id: Optional[str] = None,
        short_code: Optional[str] = None,
        transactional_messages_per_second: Optional[int] = None) -> SmsChannel
    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)
    public static SmsChannel get(String name, Output<String> id, SmsChannelState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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
    ID of the application.
    Enabled bool
    Whether the channel is enabled or disabled. By default, it is set to true.
    PromotionalMessagesPerSecond int
    Maximum number of promotional messages that can be sent per second.
    SenderId string
    Identifier of the sender for your messages.
    ShortCode string
    Short Code registered with the phone provider.
    TransactionalMessagesPerSecond int
    Maximum number of transactional messages per second that can be sent.
    ApplicationId string
    ID of the application.
    Enabled bool
    Whether the channel is enabled or disabled. By default, it is set to true.
    PromotionalMessagesPerSecond int
    Maximum number of promotional messages that can be sent per second.
    SenderId string
    Identifier of the sender for your messages.
    ShortCode string
    Short Code registered with the phone provider.
    TransactionalMessagesPerSecond int
    Maximum number of transactional messages per second that can be sent.
    applicationId String
    ID of the application.
    enabled Boolean
    Whether the channel is enabled or disabled. By default, it is set to true.
    promotionalMessagesPerSecond Integer
    Maximum number of promotional messages that can be sent per second.
    senderId String
    Identifier of the sender for your messages.
    shortCode String
    Short Code registered with the phone provider.
    transactionalMessagesPerSecond Integer
    Maximum number of transactional messages per second that can be sent.
    applicationId string
    ID of the application.
    enabled boolean
    Whether the channel is enabled or disabled. By default, it is set to true.
    promotionalMessagesPerSecond number
    Maximum number of promotional messages that can be sent per second.
    senderId string
    Identifier of the sender for your messages.
    shortCode string
    Short Code registered with the phone provider.
    transactionalMessagesPerSecond number
    Maximum number of transactional messages per second that can be sent.
    application_id str
    ID of the application.
    enabled bool
    Whether the channel is enabled or disabled. By default, it is set to true.
    promotional_messages_per_second int
    Maximum number of promotional messages that can be sent per second.
    sender_id str
    Identifier of the sender for your messages.
    short_code str
    Short Code registered with the phone provider.
    transactional_messages_per_second int
    Maximum number of transactional messages per second that can be sent.
    applicationId String
    ID of the application.
    enabled Boolean
    Whether the channel is enabled or disabled. By default, it is set to true.
    promotionalMessagesPerSecond Number
    Maximum number of promotional messages that can be sent per second.
    senderId String
    Identifier of the sender for your messages.
    shortCode String
    Short Code registered with the phone provider.
    transactionalMessagesPerSecond Number
    Maximum number of transactional messages per second that can be sent.

    Import

    Using pulumi import, import the Pinpoint SMS Channel using the application_id. For example:

    $ pulumi import aws:pinpoint/smsChannel:SmsChannel sms application-id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws