Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. smsvoice
  5. PhoneNumber

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.smsvoice.PhoneNumber

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SMSVOICE::PhoneNumber

    Create PhoneNumber Resource

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

    Constructor syntax

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

@overload
def PhoneNumber(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                iso_country_code: Optional[str] = None,
                mandatory_keywords: Optional[MandatoryKeywordsPropertiesArgs] = None,
                number_capabilities: Optional[Sequence[PhoneNumberNumberCapabilitiesItem]] = None,
                number_type: Optional[PhoneNumberNumberType] = None,
                deletion_protection_enabled: Optional[bool] = None,
                opt_out_list_name: Optional[str] = None,
                optional_keywords: Optional[Sequence[PhoneNumberOptionalKeywordArgs]] = None,
                self_managed_opt_outs_enabled: Optional[bool] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                two_way: Optional[TwoWayPropertiesArgs] = None)
    func NewPhoneNumber(ctx *Context, name string, args PhoneNumberArgs, opts ...ResourceOption) (*PhoneNumber, error)
    public PhoneNumber(string name, PhoneNumberArgs args, CustomResourceOptions? opts = null)
    public PhoneNumber(String name, PhoneNumberArgs args)
public PhoneNumber(String name, PhoneNumberArgs args, CustomResourceOptions options)

    type: aws-native:smsvoice:PhoneNumber
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 PhoneNumberArgs
    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 PhoneNumberArgs
    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 PhoneNumberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PhoneNumberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PhoneNumberArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    IsoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MandatoryKeywords Pulumi.AwsNative.Smsvoice.Inputs.MandatoryKeywordsProperties
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
    NumberCapabilities List<Pulumi.AwsNative.Smsvoice.PhoneNumberNumberCapabilitiesItem>
    Indicates if the phone number will be used for text messages, voice messages, or both.
    NumberType Pulumi.AwsNative.Smsvoice.PhoneNumberNumberType
    The type of phone number to request.
    DeletionProtectionEnabled bool
    When set to true the sender ID can't be deleted. By default this is set to false.
    OptOutListName string
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    OptionalKeywords List<Pulumi.AwsNative.Smsvoice.Inputs.PhoneNumberOptionalKeyword>
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
    SelfManagedOptOutsEnabled bool
    By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    TwoWay Pulumi.AwsNative.Smsvoice.Inputs.TwoWayProperties
    When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
    IsoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MandatoryKeywords MandatoryKeywordsPropertiesArgs
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
    NumberCapabilities []PhoneNumberNumberCapabilitiesItem
    Indicates if the phone number will be used for text messages, voice messages, or both.
    NumberType PhoneNumberNumberType
    The type of phone number to request.
    DeletionProtectionEnabled bool
    When set to true the sender ID can't be deleted. By default this is set to false.
    OptOutListName string
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    OptionalKeywords []PhoneNumberOptionalKeywordArgs
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
    SelfManagedOptOutsEnabled bool
    By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    TwoWay TwoWayPropertiesArgs
    When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
    isoCountryCode String
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    mandatoryKeywords MandatoryKeywordsProperties
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
    numberCapabilities List<PhoneNumberNumberCapabilitiesItem>
    Indicates if the phone number will be used for text messages, voice messages, or both.
    numberType PhoneNumberNumberType
    The type of phone number to request.
    deletionProtectionEnabled Boolean
    When set to true the sender ID can't be deleted. By default this is set to false.
    optOutListName String
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optionalKeywords List<PhoneNumberOptionalKeyword>
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
    selfManagedOptOutsEnabled Boolean
    By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    twoWay TwoWayProperties
    When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
    isoCountryCode string
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    mandatoryKeywords MandatoryKeywordsProperties
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
    numberCapabilities PhoneNumberNumberCapabilitiesItem[]
    Indicates if the phone number will be used for text messages, voice messages, or both.
    numberType PhoneNumberNumberType
    The type of phone number to request.
    deletionProtectionEnabled boolean
    When set to true the sender ID can't be deleted. By default this is set to false.
    optOutListName string
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optionalKeywords PhoneNumberOptionalKeyword[]
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
    selfManagedOptOutsEnabled boolean
    By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    twoWay TwoWayProperties
    When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
    iso_country_code str
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    mandatory_keywords MandatoryKeywordsPropertiesArgs
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
    number_capabilities Sequence[PhoneNumberNumberCapabilitiesItem]
    Indicates if the phone number will be used for text messages, voice messages, or both.
    number_type PhoneNumberNumberType
    The type of phone number to request.
    deletion_protection_enabled bool
    When set to true the sender ID can't be deleted. By default this is set to false.
    opt_out_list_name str
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optional_keywords Sequence[PhoneNumberOptionalKeywordArgs]
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
    self_managed_opt_outs_enabled bool
    By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    two_way TwoWayPropertiesArgs
    When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
    isoCountryCode String
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    mandatoryKeywords Property Map
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
    numberCapabilities List<"SMS" | "VOICE" | "MMS">
    Indicates if the phone number will be used for text messages, voice messages, or both.
    numberType "LONG_CODE" | "TOLL_FREE" | "TEN_DLC" | "SIMULATOR"
    The type of phone number to request.
    deletionProtectionEnabled Boolean
    When set to true the sender ID can't be deleted. By default this is set to false.
    optOutListName String
    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
    optionalKeywords List<Property Map>
    A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
    selfManagedOptOutsEnabled Boolean
    By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    twoWay Property Map
    When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.

    Outputs

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

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    PhoneNumberId string
    PhoneNumberValue string
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    PhoneNumber string
    PhoneNumberId string
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    phoneNumber String
    phoneNumberId String
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    phoneNumber string
    phoneNumberId string
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    phone_number str
    phone_number_id str
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    phoneNumber String
    phoneNumberId String

    Supporting Types

    MandatoryKeywordsProperties, MandatoryKeywordsPropertiesArgs

    PhoneNumberNumberCapabilitiesItem, PhoneNumberNumberCapabilitiesItemArgs

    Sms
    SMS
    Voice
    VOICE
    Mms
    MMS
    PhoneNumberNumberCapabilitiesItemSms
    SMS
    PhoneNumberNumberCapabilitiesItemVoice
    VOICE
    PhoneNumberNumberCapabilitiesItemMms
    MMS
    Sms
    SMS
    Voice
    VOICE
    Mms
    MMS
    Sms
    SMS
    Voice
    VOICE
    Mms
    MMS
    SMS
    SMS
    VOICE
    VOICE
    MMS
    MMS
    "SMS"
    SMS
    "VOICE"
    VOICE
    "MMS"
    MMS

    PhoneNumberNumberType, PhoneNumberNumberTypeArgs

    LongCode
    LONG_CODE
    TollFree
    TOLL_FREE
    TenDlc
    TEN_DLC
    Simulator
    SIMULATOR
    PhoneNumberNumberTypeLongCode
    LONG_CODE
    PhoneNumberNumberTypeTollFree
    TOLL_FREE
    PhoneNumberNumberTypeTenDlc
    TEN_DLC
    PhoneNumberNumberTypeSimulator
    SIMULATOR
    LongCode
    LONG_CODE
    TollFree
    TOLL_FREE
    TenDlc
    TEN_DLC
    Simulator
    SIMULATOR
    LongCode
    LONG_CODE
    TollFree
    TOLL_FREE
    TenDlc
    TEN_DLC
    Simulator
    SIMULATOR
    LONG_CODE
    LONG_CODE
    TOLL_FREE
    TOLL_FREE
    TEN_DLC
    TEN_DLC
    SIMULATOR
    SIMULATOR
    "LONG_CODE"
    LONG_CODE
    "TOLL_FREE"
    TOLL_FREE
    "TEN_DLC"
    TEN_DLC
    "SIMULATOR"
    SIMULATOR

    PhoneNumberOptionalKeyword, PhoneNumberOptionalKeywordArgs

    PhoneNumberOptionalKeywordAction, PhoneNumberOptionalKeywordActionArgs

    AutomaticResponse
    AUTOMATIC_RESPONSE
    OptOut
    OPT_OUT
    OptIn
    OPT_IN
    PhoneNumberOptionalKeywordActionAutomaticResponse
    AUTOMATIC_RESPONSE
    PhoneNumberOptionalKeywordActionOptOut
    OPT_OUT
    PhoneNumberOptionalKeywordActionOptIn
    OPT_IN
    AutomaticResponse
    AUTOMATIC_RESPONSE
    OptOut
    OPT_OUT
    OptIn
    OPT_IN
    AutomaticResponse
    AUTOMATIC_RESPONSE
    OptOut
    OPT_OUT
    OptIn
    OPT_IN
    AUTOMATIC_RESPONSE
    AUTOMATIC_RESPONSE
    OPT_OUT
    OPT_OUT
    OPT_IN
    OPT_IN
    "AUTOMATIC_RESPONSE"
    AUTOMATIC_RESPONSE
    "OPT_OUT"
    OPT_OUT
    "OPT_IN"
    OPT_IN

    PoolMandatoryKeyword, PoolMandatoryKeywordArgs

    Message string
    Message string
    message String
    message string
    message String

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TwoWayProperties, TwoWayPropertiesArgs

    Enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    ChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    ChannelRole string
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    Enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    ChannelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    ChannelRole string
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    channelRole String
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channelArn string
    The Amazon Resource Name (ARN) of the two way channel.
    channelRole string
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled bool
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channel_arn str
    The Amazon Resource Name (ARN) of the two way channel.
    channel_role str
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
    enabled Boolean
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    channelArn String
    The Amazon Resource Name (ARN) of the two way channel.
    channelRole String
    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
    pulumi/pulumi-aws-native