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

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

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

    Create Pool Resource

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

    Constructor syntax

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

@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         mandatory_keywords: Optional[MandatoryKeywordsPropertiesArgs] = None,
         origination_identities: Optional[Sequence[str]] = None,
         deletion_protection_enabled: Optional[bool] = None,
         opt_out_list_name: Optional[str] = None,
         optional_keywords: Optional[Sequence[PoolOptionalKeywordArgs]] = None,
         self_managed_opt_outs_enabled: Optional[bool] = None,
         shared_routes_enabled: Optional[bool] = None,
         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
         two_way: Optional[TwoWayPropertiesArgs] = None)
    func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)
    public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)
    public Pool(String name, PoolArgs args)
public Pool(String name, PoolArgs args, CustomResourceOptions options)

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

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

    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
    OriginationIdentities List<string>
    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
    DeletionProtectionEnabled bool
    When set to true the pool can't be deleted. By default this is set to false.
    OptOutListName string
    The name of the OptOutList to associate with the pool. You can use the OptOutListName or OptOutListArn.
    OptionalKeywords List<Pulumi.AwsNative.Smsvoice.Inputs.PoolOptionalKeyword>
    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.
    SharedRoutesEnabled bool
    Indicates whether shared routes are enabled for the pool.
    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.
    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
    OriginationIdentities []string
    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
    DeletionProtectionEnabled bool
    When set to true the pool can't be deleted. By default this is set to false.
    OptOutListName string
    The name of the OptOutList to associate with the pool. You can use the OptOutListName or OptOutListArn.
    OptionalKeywords []PoolOptionalKeywordArgs
    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.
    SharedRoutesEnabled bool
    Indicates whether shared routes are enabled for the pool.
    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.
    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
    originationIdentities List<String>
    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
    deletionProtectionEnabled Boolean
    When set to true the pool can't be deleted. By default this is set to false.
    optOutListName String
    The name of the OptOutList to associate with the pool. You can use the OptOutListName or OptOutListArn.
    optionalKeywords List<PoolOptionalKeyword>
    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.
    sharedRoutesEnabled Boolean
    Indicates whether shared routes are enabled for the pool.
    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.
    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
    originationIdentities string[]
    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
    deletionProtectionEnabled boolean
    When set to true the pool can't be deleted. By default this is set to false.
    optOutListName string
    The name of the OptOutList to associate with the pool. You can use the OptOutListName or OptOutListArn.
    optionalKeywords PoolOptionalKeyword[]
    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.
    sharedRoutesEnabled boolean
    Indicates whether shared routes are enabled for the pool.
    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.
    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
    origination_identities Sequence[str]
    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
    deletion_protection_enabled bool
    When set to true the pool 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 pool. You can use the OptOutListName or OptOutListArn.
    optional_keywords Sequence[PoolOptionalKeywordArgs]
    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.
    shared_routes_enabled bool
    Indicates whether shared routes are enabled for the pool.
    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.
    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
    originationIdentities List<String>
    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
    deletionProtectionEnabled Boolean
    When set to true the pool can't be deleted. By default this is set to false.
    optOutListName String
    The name of the OptOutList to associate with the pool. 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.
    sharedRoutesEnabled Boolean
    Indicates whether shared routes are enabled for the pool.
    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 Pool resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    PoolId string
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    PoolId string
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    poolId String
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    poolId string
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    pool_id str
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    poolId String

    Supporting Types

    MandatoryKeywordsProperties, MandatoryKeywordsPropertiesArgs

    PoolMandatoryKeyword, PoolMandatoryKeywordArgs

    Message string
    Message string
    message String
    message string
    message String

    PoolOptionalKeyword, PoolOptionalKeywordArgs

    PoolOptionalKeywordAction, PoolOptionalKeywordActionArgs

    AutomaticResponse
    AUTOMATIC_RESPONSE
    OptOut
    OPT_OUT
    OptIn
    OPT_IN
    PoolOptionalKeywordActionAutomaticResponse
    AUTOMATIC_RESPONSE
    PoolOptionalKeywordActionOptOut
    OPT_OUT
    PoolOptionalKeywordActionOptIn
    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

    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