Class 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,
});
}
}
Inherited Members
Namespace: Pulumi.Aws.Pinpoint
Assembly: Pulumi.Aws.dll
Syntax
public class SmsChannel : CustomResource
Constructors
View SourceSmsChannel(String, SmsChannelArgs, CustomResourceOptions)
Create a SmsChannel resource with the given unique name, arguments, and options.
Declaration
public SmsChannel(string name, SmsChannelArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| SmsChannelArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceApplicationId
The application ID.
Declaration
public Output<string> ApplicationId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Enabled
Whether the channel is enabled or disabled. Defaults to true.
Declaration
public Output<bool?> Enabled { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
PromotionalMessagesPerSecond
Promotional messages per second that can be sent.
Declaration
public Output<int> PromotionalMessagesPerSecond { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
SenderId
Sender identifier of your messages.
Declaration
public Output<string> SenderId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ShortCode
The Short Code registered with the phone provider.
Declaration
public Output<string> ShortCode { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
TransactionalMessagesPerSecond
Transactional messages per second that can be sent.
Declaration
public Output<int> TransactionalMessagesPerSecond { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
Methods
View SourceGet(String, Input<String>, SmsChannelState, CustomResourceOptions)
Get an existing SmsChannel resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static SmsChannel Get(string name, Input<string> id, SmsChannelState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| SmsChannelState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| SmsChannel |