pulumi-aws-kotlin/com.pulumi.aws.pinpoint.kotlin/Smsvoicev2PhoneNumberArgs

Smsvoicev2PhoneNumberArgs

data class Smsvoicev2PhoneNumberArgs(val deletionProtectionEnabled: Output<Boolean>? = null, val isoCountryCode: Output<String>? = null, val messageType: Output<String>? = null, val numberCapabilities: Output<List<String>>? = null, val numberType: Output<String>? = null, val optOutListName: Output<String>? = null, val registrationId: Output<String>? = null, val selfManagedOptOutsEnabled: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null, val timeouts: Output<Smsvoicev2PhoneNumberTimeoutsArgs>? = null, val twoWayChannelArn: Output<String>? = null, val twoWayChannelEnabled: Output<Boolean>? = null) : ConvertibleToJava<Smsvoicev2PhoneNumberArgs>

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

Constructors

Smsvoicev2PhoneNumberArgs

constructor(deletionProtectionEnabled: Output<Boolean>? = null, isoCountryCode: Output<String>? = null, messageType: Output<String>? = null, numberCapabilities: Output<List<String>>? = null, numberType: Output<String>? = null, optOutListName: Output<String>? = null, registrationId: Output<String>? = null, selfManagedOptOutsEnabled: Output<Boolean>? = null, tags: Output<Map<String, String>>? = null, timeouts: Output<Smsvoicev2PhoneNumberTimeoutsArgs>? = null, twoWayChannelArn: Output<String>? = null, twoWayChannelEnabled: Output<Boolean>? = null)

Properties

deletionProtectionEnabled

val deletionProtectionEnabled: Output<Boolean>? = null

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

isoCountryCode

val isoCountryCode: Output<String>? = null

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

messageType

val messageType: Output<String>? = null

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.

numberCapabilities

val numberCapabilities: Output<List<String>>? = null

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

numberType

val numberType: Output<String>? = null

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

optOutListName

val optOutListName: Output<String>? = null

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

registrationId

val registrationId: Output<String>? = null

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

selfManagedOptOutsEnabled

val selfManagedOptOutsEnabled: Output<Boolean>? = null

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.

Functions

toJava

open override fun toJava(): Smsvoicev2PhoneNumberArgs