Smsvoicev2PhoneNumber

class Smsvoicev2PhoneNumber : KotlinCustomResource

Manages an AWS End User Messaging SMS phone number.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.pinpoint.Smsvoicev2PhoneNumber("example", {
isoCountryCode: "US",
messageType: "TRANSACTIONAL",
numberType: "TOLL_FREE",
numberCapabilities: ["SMS"],
});
import pulumi
import pulumi_aws as aws
example = aws.pinpoint.Smsvoicev2PhoneNumber("example",
iso_country_code="US",
message_type="TRANSACTIONAL",
number_type="TOLL_FREE",
number_capabilities=["SMS"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Pinpoint.Smsvoicev2PhoneNumber("example", new()
{
IsoCountryCode = "US",
MessageType = "TRANSACTIONAL",
NumberType = "TOLL_FREE",
NumberCapabilities = new[]
{
"SMS",
},
});
});
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 {
_, err := pinpoint.NewSmsvoicev2PhoneNumber(ctx, "example", &pinpoint.Smsvoicev2PhoneNumberArgs{
IsoCountryCode: pulumi.String("US"),
MessageType: pulumi.String("TRANSACTIONAL"),
NumberType: pulumi.String("TOLL_FREE"),
NumberCapabilities: pulumi.StringArray{
pulumi.String("SMS"),
},
})
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.Smsvoicev2PhoneNumber;
import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumberArgs;
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 example = new Smsvoicev2PhoneNumber("example", Smsvoicev2PhoneNumberArgs.builder()
.isoCountryCode("US")
.messageType("TRANSACTIONAL")
.numberType("TOLL_FREE")
.numberCapabilities("SMS")
.build());
}
}
resources:
example:
type: aws:pinpoint:Smsvoicev2PhoneNumber
properties:
isoCountryCode: US
messageType: TRANSACTIONAL
numberType: TOLL_FREE
numberCapabilities:
- SMS

Import

Using pulumi import, import phone numbers using the id. For example:

$ pulumi import aws:pinpoint/smsvoicev2PhoneNumber:Smsvoicev2PhoneNumber example phone-abcdef0123456789abcdef0123456789

Properties

Link copied to clipboard
val arn: Output<String>

ARN of the phone number.

Link copied to clipboard

By default this is set to false. When set to true the phone number can’t be deleted.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val isoCountryCode: Output<String>

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Link copied to clipboard
val messageType: Output<String>

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

Link copied to clipboard

The monthly price, in US dollars, to lease the phone number.

Link copied to clipboard

Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.

Link copied to clipboard
val numberType: Output<String>

The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.

Link copied to clipboard
val optOutListName: Output<String>

The name of the opt-out list to associate with the phone number.

Link copied to clipboard
val phoneNumber: Output<String>

The new phone number that was requested.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val registrationId: Output<String>?

Use this field to attach your phone number for an external registration process.

Link copied to clipboard

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the opt-out list. When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out request.

Link copied to clipboard
val tags: Output<Map<String, String>>?
Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
Link copied to clipboard
val twoWayChannelArn: Output<String>?

The Amazon Resource Name (ARN) of the two way channel.

Link copied to clipboard

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Link copied to clipboard
val urn: Output<String>