SmsChannel class
Use the aws.pinpoint.SmsChannel resource to manage End User Messaging SMS Channels.
> NOTE: AWS has feature frozen the SMS channel of End User Messaging.
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)
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_pinpoint_smschannel" "sms" {
application_id = aws_pinpoint_app.app.application_id
}
resource "aws_pinpoint_app" "app" {
}
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.ArrayList;
import java.util.Arrays;
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
Import
Using pulumi import, import the End User Messaging SMS Channel using the applicationId. For example:
$ pulumi import aws:pinpoint/smsChannel:SmsChannel sms application-id
Constructors
- SmsChannel(String name, {SmsChannelArgs? args, CustomResourceOptions? options})
-
Creates a new SmsChannel.
nameThe Pulumi resource name.argsArguments used to configure this SmsChannel. The set of arguments for SmsChannel.optionsResource options controlling this resource's behavior. - SmsChannel.reference(String urn)
- Creates a typed reference to an existing SmsChannel resource.
Properties
-
applicationId
↔ Output<
String> -
ID of the application.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
enabled
↔ Output<
bool?> -
Whether the channel is enabled or disabled. By default, it is set to
true.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
promotionalMessagesPerSecond
↔ Output<
int> -
Maximum number of promotional messages that can be sent per second.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
senderId
↔ Output<
String?> -
Identifier of the sender for your messages.
latefinal
-
shortCode
↔ Output<
String?> -
Short Code registered with the phone provider.
latefinal
-
transactionalMessagesPerSecond
↔ Output<
int> -
Maximum number of transactional messages per second that can be sent.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {SmsChannelState? state, CustomResourceOptions? options}) → SmsChannel -
Gets an existing SmsChannel resource's state with the given
nameandid.