Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. pinpoint
  5. Smsvoicev2PhoneNumber
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.pinpoint.Smsvoicev2PhoneNumber

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    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"])

    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
	})
}

    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 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

    Create Smsvoicev2PhoneNumber Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Smsvoicev2PhoneNumber(name: string, args: Smsvoicev2PhoneNumberArgs, opts?: CustomResourceOptions);
    @overload
def Smsvoicev2PhoneNumber(resource_name: str,
                          args: Smsvoicev2PhoneNumberArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def Smsvoicev2PhoneNumber(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          iso_country_code: Optional[str] = None,
                          message_type: Optional[str] = None,
                          number_capabilities: Optional[Sequence[str]] = None,
                          number_type: Optional[str] = None,
                          deletion_protection_enabled: Optional[bool] = None,
                          opt_out_list_name: Optional[str] = None,
                          registration_id: Optional[str] = None,
                          self_managed_opt_outs_enabled: Optional[bool] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          timeouts: Optional[Smsvoicev2PhoneNumberTimeoutsArgs] = None,
                          two_way_channel_arn: Optional[str] = None,
                          two_way_channel_enabled: Optional[bool] = None)
    func NewSmsvoicev2PhoneNumber(ctx *Context, name string, args Smsvoicev2PhoneNumberArgs, opts ...ResourceOption) (*Smsvoicev2PhoneNumber, error)
    public Smsvoicev2PhoneNumber(string name, Smsvoicev2PhoneNumberArgs args, CustomResourceOptions? opts = null)
    public Smsvoicev2PhoneNumber(String name, Smsvoicev2PhoneNumberArgs args)
public Smsvoicev2PhoneNumber(String name, Smsvoicev2PhoneNumberArgs args, CustomResourceOptions options)

    type: aws:pinpoint:Smsvoicev2PhoneNumber
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 Smsvoicev2PhoneNumberArgs
    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 Smsvoicev2PhoneNumberArgs
    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 Smsvoicev2PhoneNumberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Smsvoicev2PhoneNumberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Smsvoicev2PhoneNumberArgs
    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 smsvoicev2PhoneNumberResource = new Aws.Pinpoint.Smsvoicev2PhoneNumber("smsvoicev2PhoneNumberResource", new()
{
    IsoCountryCode = "string",
    MessageType = "string",
    NumberCapabilities = new[]
    {
        "string",
    },
    NumberType = "string",
    DeletionProtectionEnabled = false,
    OptOutListName = "string",
    RegistrationId = "string",
    SelfManagedOptOutsEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Pinpoint.Inputs.Smsvoicev2PhoneNumberTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    TwoWayChannelArn = "string",
    TwoWayChannelEnabled = false,
});

    example, err := pinpoint.NewSmsvoicev2PhoneNumber(ctx, "smsvoicev2PhoneNumberResource", &pinpoint.Smsvoicev2PhoneNumberArgs{
	IsoCountryCode: pulumi.String("string"),
	MessageType:    pulumi.String("string"),
	NumberCapabilities: pulumi.StringArray{
		pulumi.String("string"),
	},
	NumberType:                pulumi.String("string"),
	DeletionProtectionEnabled: pulumi.Bool(false),
	OptOutListName:            pulumi.String("string"),
	RegistrationId:            pulumi.String("string"),
	SelfManagedOptOutsEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &pinpoint.Smsvoicev2PhoneNumberTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	TwoWayChannelArn:     pulumi.String("string"),
	TwoWayChannelEnabled: pulumi.Bool(false),
})

    var smsvoicev2PhoneNumberResource = new Smsvoicev2PhoneNumber("smsvoicev2PhoneNumberResource", Smsvoicev2PhoneNumberArgs.builder()
    .isoCountryCode("string")
    .messageType("string")
    .numberCapabilities("string")
    .numberType("string")
    .deletionProtectionEnabled(false)
    .optOutListName("string")
    .registrationId("string")
    .selfManagedOptOutsEnabled(false)
    .tags(Map.of("string", "string"))
    .timeouts(Smsvoicev2PhoneNumberTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .twoWayChannelArn("string")
    .twoWayChannelEnabled(false)
    .build());

    smsvoicev2_phone_number_resource = aws.pinpoint.Smsvoicev2PhoneNumber("smsvoicev2PhoneNumberResource",
    iso_country_code="string",
    message_type="string",
    number_capabilities=["string"],
    number_type="string",
    deletion_protection_enabled=False,
    opt_out_list_name="string",
    registration_id="string",
    self_managed_opt_outs_enabled=False,
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    two_way_channel_arn="string",
    two_way_channel_enabled=False)

    const smsvoicev2PhoneNumberResource = new aws.pinpoint.Smsvoicev2PhoneNumber("smsvoicev2PhoneNumberResource", {
    isoCountryCode: "string",
    messageType: "string",
    numberCapabilities: ["string"],
    numberType: "string",
    deletionProtectionEnabled: false,
    optOutListName: "string",
    registrationId: "string",
    selfManagedOptOutsEnabled: false,
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    twoWayChannelArn: "string",
    twoWayChannelEnabled: false,
});

    type: aws:pinpoint:Smsvoicev2PhoneNumber
properties:
    deletionProtectionEnabled: false
    isoCountryCode: string
    messageType: string
    numberCapabilities:
        - string
    numberType: string
    optOutListName: string
    registrationId: string
    selfManagedOptOutsEnabled: false
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    twoWayChannelArn: string
    twoWayChannelEnabled: false

    Smsvoicev2PhoneNumber 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 Smsvoicev2PhoneNumber resource accepts the following input properties:

    IsoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MessageType 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.
    NumberCapabilities List<string>
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    NumberType string
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    DeletionProtectionEnabled bool
    By default this is set to false. When set to true the phone number can’t be deleted.
    OptOutListName string
    The name of the opt-out list to associate with the phone number.
    RegistrationId string
    Use this field to attach your phone number for an external registration process.
    SelfManagedOptOutsEnabled bool
    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.
    Tags Dictionary<string, string>
    Timeouts Smsvoicev2PhoneNumberTimeouts
    TwoWayChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    TwoWayChannelEnabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    IsoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MessageType 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.
    NumberCapabilities []string
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    NumberType string
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    DeletionProtectionEnabled bool
    By default this is set to false. When set to true the phone number can’t be deleted.
    OptOutListName string
    The name of the opt-out list to associate with the phone number.
    RegistrationId string
    Use this field to attach your phone number for an external registration process.
    SelfManagedOptOutsEnabled bool
    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.
    Tags map[string]string
    Timeouts Smsvoicev2PhoneNumberTimeoutsArgs
    TwoWayChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    TwoWayChannelEnabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    isoCountryCode String
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageType 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.
    numberCapabilities List<String>
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    numberType String
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    deletionProtectionEnabled Boolean
    By default this is set to false. When set to true the phone number can’t be deleted.
    optOutListName String
    The name of the opt-out list to associate with the phone number.
    registrationId String
    Use this field to attach your phone number for an external registration process.
    selfManagedOptOutsEnabled Boolean
    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.
    tags Map<String,String>
    timeouts Smsvoicev2PhoneNumberTimeouts
    twoWayChannelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    twoWayChannelEnabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    isoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageType 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.
    numberCapabilities string[]
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    numberType string
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    deletionProtectionEnabled boolean
    By default this is set to false. When set to true the phone number can’t be deleted.
    optOutListName string
    The name of the opt-out list to associate with the phone number.
    registrationId string
    Use this field to attach your phone number for an external registration process.
    selfManagedOptOutsEnabled boolean
    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.
    tags {[key: string]: string}
    timeouts Smsvoicev2PhoneNumberTimeouts
    twoWayChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    twoWayChannelEnabled boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    iso_country_code str
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    message_type str
    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.
    number_capabilities Sequence[str]
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    number_type str
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    deletion_protection_enabled bool
    By default this is set to false. When set to true the phone number can’t be deleted.
    opt_out_list_name str
    The name of the opt-out list to associate with the phone number.
    registration_id str
    Use this field to attach your phone number for an external registration process.
    self_managed_opt_outs_enabled bool
    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.
    tags Mapping[str, str]
    timeouts Smsvoicev2PhoneNumberTimeoutsArgs
    two_way_channel_arn str
    The Amazon Resource Name (ARN) of the two way channel.
    two_way_channel_enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    isoCountryCode String
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageType 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.
    numberCapabilities List<String>
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    numberType String
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    deletionProtectionEnabled Boolean
    By default this is set to false. When set to true the phone number can’t be deleted.
    optOutListName String
    The name of the opt-out list to associate with the phone number.
    registrationId String
    Use this field to attach your phone number for an external registration process.
    selfManagedOptOutsEnabled Boolean
    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.
    tags Map<String>
    timeouts Property Map
    twoWayChannelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    twoWayChannelEnabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Smsvoicev2PhoneNumber resource produces the following output properties:

    Arn string
    ARN of the phone number.
    Id string
    The provider-assigned unique ID for this managed resource.
    MonthlyLeasingPrice string
    The monthly price, in US dollars, to lease the phone number.
    PhoneNumber string
    The new phone number that was requested.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the phone number.
    Id string
    The provider-assigned unique ID for this managed resource.
    MonthlyLeasingPrice string
    The monthly price, in US dollars, to lease the phone number.
    PhoneNumber string
    The new phone number that was requested.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the phone number.
    id String
    The provider-assigned unique ID for this managed resource.
    monthlyLeasingPrice String
    The monthly price, in US dollars, to lease the phone number.
    phoneNumber String
    The new phone number that was requested.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the phone number.
    id string
    The provider-assigned unique ID for this managed resource.
    monthlyLeasingPrice string
    The monthly price, in US dollars, to lease the phone number.
    phoneNumber string
    The new phone number that was requested.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the phone number.
    id str
    The provider-assigned unique ID for this managed resource.
    monthly_leasing_price str
    The monthly price, in US dollars, to lease the phone number.
    phone_number str
    The new phone number that was requested.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the phone number.
    id String
    The provider-assigned unique ID for this managed resource.
    monthlyLeasingPrice String
    The monthly price, in US dollars, to lease the phone number.
    phoneNumber String
    The new phone number that was requested.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Smsvoicev2PhoneNumber Resource

    Get an existing Smsvoicev2PhoneNumber 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?: Smsvoicev2PhoneNumberState, opts?: CustomResourceOptions): Smsvoicev2PhoneNumber
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        deletion_protection_enabled: Optional[bool] = None,
        iso_country_code: Optional[str] = None,
        message_type: Optional[str] = None,
        monthly_leasing_price: Optional[str] = None,
        number_capabilities: Optional[Sequence[str]] = None,
        number_type: Optional[str] = None,
        opt_out_list_name: Optional[str] = None,
        phone_number: Optional[str] = None,
        registration_id: Optional[str] = None,
        self_managed_opt_outs_enabled: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[Smsvoicev2PhoneNumberTimeoutsArgs] = None,
        two_way_channel_arn: Optional[str] = None,
        two_way_channel_enabled: Optional[bool] = None) -> Smsvoicev2PhoneNumber
    func GetSmsvoicev2PhoneNumber(ctx *Context, name string, id IDInput, state *Smsvoicev2PhoneNumberState, opts ...ResourceOption) (*Smsvoicev2PhoneNumber, error)
    public static Smsvoicev2PhoneNumber Get(string name, Input<string> id, Smsvoicev2PhoneNumberState? state, CustomResourceOptions? opts = null)
    public static Smsvoicev2PhoneNumber get(String name, Output<String> id, Smsvoicev2PhoneNumberState state, CustomResourceOptions options)
    resources:  _:    type: aws:pinpoint:Smsvoicev2PhoneNumber    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.
    The following state arguments are supported:
    Arn string
    ARN of the phone number.
    DeletionProtectionEnabled bool
    By default this is set to false. When set to true the phone number can’t be deleted.
    IsoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MessageType 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.
    MonthlyLeasingPrice string
    The monthly price, in US dollars, to lease the phone number.
    NumberCapabilities List<string>
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    NumberType string
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    OptOutListName string
    The name of the opt-out list to associate with the phone number.
    PhoneNumber string
    The new phone number that was requested.
    RegistrationId string
    Use this field to attach your phone number for an external registration process.
    SelfManagedOptOutsEnabled bool
    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.
    Tags Dictionary<string, string>
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts Smsvoicev2PhoneNumberTimeouts
    TwoWayChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    TwoWayChannelEnabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    Arn string
    ARN of the phone number.
    DeletionProtectionEnabled bool
    By default this is set to false. When set to true the phone number can’t be deleted.
    IsoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MessageType 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.
    MonthlyLeasingPrice string
    The monthly price, in US dollars, to lease the phone number.
    NumberCapabilities []string
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    NumberType string
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    OptOutListName string
    The name of the opt-out list to associate with the phone number.
    PhoneNumber string
    The new phone number that was requested.
    RegistrationId string
    Use this field to attach your phone number for an external registration process.
    SelfManagedOptOutsEnabled bool
    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.
    Tags map[string]string
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts Smsvoicev2PhoneNumberTimeoutsArgs
    TwoWayChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    TwoWayChannelEnabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    arn String
    ARN of the phone number.
    deletionProtectionEnabled Boolean
    By default this is set to false. When set to true the phone number can’t be deleted.
    isoCountryCode String
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageType 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.
    monthlyLeasingPrice String
    The monthly price, in US dollars, to lease the phone number.
    numberCapabilities List<String>
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    numberType String
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    optOutListName String
    The name of the opt-out list to associate with the phone number.
    phoneNumber String
    The new phone number that was requested.
    registrationId String
    Use this field to attach your phone number for an external registration process.
    selfManagedOptOutsEnabled Boolean
    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.
    tags Map<String,String>
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts Smsvoicev2PhoneNumberTimeouts
    twoWayChannelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    twoWayChannelEnabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    arn string
    ARN of the phone number.
    deletionProtectionEnabled boolean
    By default this is set to false. When set to true the phone number can’t be deleted.
    isoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageType 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.
    monthlyLeasingPrice string
    The monthly price, in US dollars, to lease the phone number.
    numberCapabilities string[]
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    numberType string
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    optOutListName string
    The name of the opt-out list to associate with the phone number.
    phoneNumber string
    The new phone number that was requested.
    registrationId string
    Use this field to attach your phone number for an external registration process.
    selfManagedOptOutsEnabled boolean
    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.
    tags {[key: string]: string}
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts Smsvoicev2PhoneNumberTimeouts
    twoWayChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    twoWayChannelEnabled boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    arn str
    ARN of the phone number.
    deletion_protection_enabled bool
    By default this is set to false. When set to true the phone number can’t be deleted.
    iso_country_code str
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    message_type str
    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.
    monthly_leasing_price str
    The monthly price, in US dollars, to lease the phone number.
    number_capabilities Sequence[str]
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    number_type str
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    opt_out_list_name str
    The name of the opt-out list to associate with the phone number.
    phone_number str
    The new phone number that was requested.
    registration_id str
    Use this field to attach your phone number for an external registration process.
    self_managed_opt_outs_enabled bool
    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.
    tags Mapping[str, str]
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts Smsvoicev2PhoneNumberTimeoutsArgs
    two_way_channel_arn str
    The Amazon Resource Name (ARN) of the two way channel.
    two_way_channel_enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    arn String
    ARN of the phone number.
    deletionProtectionEnabled Boolean
    By default this is set to false. When set to true the phone number can’t be deleted.
    isoCountryCode String
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageType 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.
    monthlyLeasingPrice String
    The monthly price, in US dollars, to lease the phone number.
    numberCapabilities List<String>
    Describes if the origination identity can be used for text messages, voice calls or both. valid values are SMS and VOICE.
    numberType String
    The type of phone number to request. Possible values are LONG_CODE, TOLL_FREE, TEN_DLC, or SIMULATOR.
    optOutListName String
    The name of the opt-out list to associate with the phone number.
    phoneNumber String
    The new phone number that was requested.
    registrationId String
    Use this field to attach your phone number for an external registration process.
    selfManagedOptOutsEnabled Boolean
    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.
    tags Map<String>
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts Property Map
    twoWayChannelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    twoWayChannelEnabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    Supporting Types

    Smsvoicev2PhoneNumberTimeouts, Smsvoicev2PhoneNumberTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

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

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

    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 aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws