published on Tuesday, Mar 10, 2026 by Pulumi
published on Tuesday, Mar 10, 2026 by Pulumi
Provides a Pinpoint SMS Channel resource.
Example Usage
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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
})
}
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());
}
}
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)
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SmsChannel resource accepts the following input properties:
- Application
Id string - The application ID.
- Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Sender
Id string - Sender identifier of your messages.
- Short
Code string - The Short Code registered with the phone provider.
- Application
Id string - The application ID.
- Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Sender
Id string - Sender identifier of your messages.
- Short
Code string - The Short Code registered with the phone provider.
- application
Id String - The application ID.
- enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - sender
Id String - Sender identifier of your messages.
- short
Code String - The Short Code registered with the phone provider.
- application
Id string - The application ID.
- enabled boolean
- Whether the channel is enabled or disabled. Defaults to
true. - sender
Id string - Sender identifier of your messages.
- short
Code 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.
- application
Id String - The application ID.
- enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - sender
Id String - Sender identifier of your messages.
- short
Code String - 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.
- Promotional
Messages intPer Second - Promotional messages per second that can be sent.
- Transactional
Messages intPer Second - Transactional messages per second that can be sent.
- Id string
- The provider-assigned unique ID for this managed resource.
- Promotional
Messages intPer Second - Promotional messages per second that can be sent.
- Transactional
Messages intPer Second - Transactional messages per second that can be sent.
- id String
- The provider-assigned unique ID for this managed resource.
- promotional
Messages IntegerPer Second - Promotional messages per second that can be sent.
- transactional
Messages IntegerPer Second - Transactional messages per second that can be sent.
- id string
- The provider-assigned unique ID for this managed resource.
- promotional
Messages numberPer Second - Promotional messages per second that can be sent.
- transactional
Messages numberPer Second - Transactional messages per second that can be sent.
- id str
- The provider-assigned unique ID for this managed resource.
- promotional_
messages_ intper_ second - Promotional messages per second that can be sent.
- transactional_
messages_ intper_ second - Transactional messages per second that can be sent.
- id String
- The provider-assigned unique ID for this managed resource.
- promotional
Messages NumberPer Second - Promotional messages per second that can be sent.
- transactional
Messages NumberPer Second - 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) -> SmsChannelfunc 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)resources: _: type: aws:pinpoint:SmsChannel get: id: ${id}- 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.
- Application
Id string - The application ID.
- Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Promotional
Messages intPer Second - Promotional messages per second that can be sent.
- Sender
Id string - Sender identifier of your messages.
- Short
Code string - The Short Code registered with the phone provider.
- Transactional
Messages intPer Second - Transactional messages per second that can be sent.
- Application
Id string - The application ID.
- Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Promotional
Messages intPer Second - Promotional messages per second that can be sent.
- Sender
Id string - Sender identifier of your messages.
- Short
Code string - The Short Code registered with the phone provider.
- Transactional
Messages intPer Second - Transactional messages per second that can be sent.
- application
Id String - The application ID.
- enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - promotional
Messages IntegerPer Second - Promotional messages per second that can be sent.
- sender
Id String - Sender identifier of your messages.
- short
Code String - The Short Code registered with the phone provider.
- transactional
Messages IntegerPer Second - Transactional messages per second that can be sent.
- application
Id string - The application ID.
- enabled boolean
- Whether the channel is enabled or disabled. Defaults to
true. - promotional
Messages numberPer Second - Promotional messages per second that can be sent.
- sender
Id string - Sender identifier of your messages.
- short
Code string - The Short Code registered with the phone provider.
- transactional
Messages numberPer Second - 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_ intper_ second - 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_ intper_ second - Transactional messages per second that can be sent.
- application
Id String - The application ID.
- enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - promotional
Messages NumberPer Second - Promotional messages per second that can be sent.
- sender
Id String - Sender identifier of your messages.
- short
Code String - The Short Code registered with the phone provider.
- transactional
Messages NumberPer Second - Transactional messages per second that can be sent.
Import
Pinpoint SMS Channel can be imported using the application-id, e.g.,
$ 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
awsTerraform Provider.
published on Tuesday, Mar 10, 2026 by Pulumi
