1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. smsvoice
  6. NotifyConfiguration

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    A notify configuration defines the settings used to send templated messages with AWS End User Messaging SMS managed messaging, including the display name, use case, enabled channels, and enabled countries.

    Create NotifyConfiguration Resource

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

    Constructor syntax

    new NotifyConfiguration(name: string, args: NotifyConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def NotifyConfiguration(resource_name: str,
                            args: NotifyConfigurationArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def NotifyConfiguration(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            display_name: Optional[str] = None,
                            enabled_channels: Optional[Sequence[NotifyConfigurationEnabledChannelsItem]] = None,
                            use_case: Optional[NotifyConfigurationUseCase] = None,
                            default_template_id: Optional[str] = None,
                            deletion_protection_enabled: Optional[bool] = None,
                            enabled_countries: Optional[Sequence[str]] = None,
                            pool_id: Optional[str] = None,
                            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewNotifyConfiguration(ctx *Context, name string, args NotifyConfigurationArgs, opts ...ResourceOption) (*NotifyConfiguration, error)
    public NotifyConfiguration(string name, NotifyConfigurationArgs args, CustomResourceOptions? opts = null)
    public NotifyConfiguration(String name, NotifyConfigurationArgs args)
    public NotifyConfiguration(String name, NotifyConfigurationArgs args, CustomResourceOptions options)
    
    type: aws-native:smsvoice:NotifyConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_smsvoice_notify_configuration" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args NotifyConfigurationArgs
    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 NotifyConfigurationArgs
    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 NotifyConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotifyConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotifyConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    DisplayName string
    The display name to associate with the notify configuration.
    EnabledChannels List<Pulumi.AwsNative.Smsvoice.NotifyConfigurationEnabledChannelsItem>
    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
    UseCase Pulumi.AwsNative.Smsvoice.NotifyConfigurationUseCase
    The use case for the notify configuration.
    DefaultTemplateId string
    The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
    DeletionProtectionEnabled bool
    By default this is set to false. When set to true the notify configuration can't be deleted.
    EnabledCountries List<string>
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
    PoolId string
    The identifier of the pool to associate with the notify configuration.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of tags (key and value pairs) associated with the notify configuration.
    DisplayName string
    The display name to associate with the notify configuration.
    EnabledChannels []NotifyConfigurationEnabledChannelsItem
    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
    UseCase NotifyConfigurationUseCase
    The use case for the notify configuration.
    DefaultTemplateId string
    The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
    DeletionProtectionEnabled bool
    By default this is set to false. When set to true the notify configuration can't be deleted.
    EnabledCountries []string
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
    PoolId string
    The identifier of the pool to associate with the notify configuration.
    Tags TagArgs
    An array of tags (key and value pairs) associated with the notify configuration.
    display_name string
    The display name to associate with the notify configuration.
    enabled_channels list("SMS" | "VOICE" | "MMS" | "RCS")
    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
    use_case "CODE_VERIFICATION"
    The use case for the notify configuration.
    default_template_id string
    The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
    deletion_protection_enabled bool
    By default this is set to false. When set to true the notify configuration can't be deleted.
    enabled_countries list(string)
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
    pool_id string
    The identifier of the pool to associate with the notify configuration.
    tags list(object)
    An array of tags (key and value pairs) associated with the notify configuration.
    displayName String
    The display name to associate with the notify configuration.
    enabledChannels List<NotifyConfigurationEnabledChannelsItem>
    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
    useCase NotifyConfigurationUseCase
    The use case for the notify configuration.
    defaultTemplateId String
    The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
    deletionProtectionEnabled Boolean
    By default this is set to false. When set to true the notify configuration can't be deleted.
    enabledCountries List<String>
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
    poolId String
    The identifier of the pool to associate with the notify configuration.
    tags List<Tag>
    An array of tags (key and value pairs) associated with the notify configuration.
    displayName string
    The display name to associate with the notify configuration.
    enabledChannels NotifyConfigurationEnabledChannelsItem[]
    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
    useCase NotifyConfigurationUseCase
    The use case for the notify configuration.
    defaultTemplateId string
    The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
    deletionProtectionEnabled boolean
    By default this is set to false. When set to true the notify configuration can't be deleted.
    enabledCountries string[]
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
    poolId string
    The identifier of the pool to associate with the notify configuration.
    tags Tag[]
    An array of tags (key and value pairs) associated with the notify configuration.
    display_name str
    The display name to associate with the notify configuration.
    enabled_channels Sequence[NotifyConfigurationEnabledChannelsItem]
    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
    use_case NotifyConfigurationUseCase
    The use case for the notify configuration.
    default_template_id str
    The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
    deletion_protection_enabled bool
    By default this is set to false. When set to true the notify configuration can't be deleted.
    enabled_countries Sequence[str]
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
    pool_id str
    The identifier of the pool to associate with the notify configuration.
    tags Sequence[TagArgs]
    An array of tags (key and value pairs) associated with the notify configuration.
    displayName String
    The display name to associate with the notify configuration.
    enabledChannels List<"SMS" | "VOICE" | "MMS" | "RCS">
    An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
    useCase "CODE_VERIFICATION"
    The use case for the notify configuration.
    defaultTemplateId String
    The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
    deletionProtectionEnabled Boolean
    By default this is set to false. When set to true the notify configuration can't be deleted.
    enabledCountries List<String>
    An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
    poolId String
    The identifier of the pool to associate with the notify configuration.
    tags List<Property Map>
    An array of tags (key and value pairs) associated with the notify configuration.

    Outputs

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

    CreatedTimestamp string
    The time when the notify configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NotifyConfigurationArn string
    The Amazon Resource Name (ARN) for the notify configuration.
    NotifyConfigurationId string
    The unique identifier for the notify configuration.
    Status Pulumi.AwsNative.Smsvoice.NotifyConfigurationStatus
    The current status of the notify configuration.
    Tier Pulumi.AwsNative.Smsvoice.NotifyConfigurationTier
    The tier of the notify configuration.
    TierUpgradeStatus Pulumi.AwsNative.Smsvoice.NotifyConfigurationTierUpgradeStatus
    The tier upgrade status of the notify configuration.
    CreatedTimestamp string
    The time when the notify configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NotifyConfigurationArn string
    The Amazon Resource Name (ARN) for the notify configuration.
    NotifyConfigurationId string
    The unique identifier for the notify configuration.
    Status NotifyConfigurationStatus
    The current status of the notify configuration.
    Tier NotifyConfigurationTier
    The tier of the notify configuration.
    TierUpgradeStatus NotifyConfigurationTierUpgradeStatus
    The tier upgrade status of the notify configuration.
    created_timestamp string
    The time when the notify configuration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    notify_configuration_arn string
    The Amazon Resource Name (ARN) for the notify configuration.
    notify_configuration_id string
    The unique identifier for the notify configuration.
    status "PENDING" | "ACTIVE" | "REJECTED" | "REQUIRES_VERIFICATION"
    The current status of the notify configuration.
    tier "BASIC" | "ADVANCED"
    The tier of the notify configuration.
    tier_upgrade_status "BASIC" | "PENDING_UPGRADE" | "ADVANCED" | "REJECTED"
    The tier upgrade status of the notify configuration.
    createdTimestamp String
    The time when the notify configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    notifyConfigurationArn String
    The Amazon Resource Name (ARN) for the notify configuration.
    notifyConfigurationId String
    The unique identifier for the notify configuration.
    status NotifyConfigurationStatus
    The current status of the notify configuration.
    tier NotifyConfigurationTier
    The tier of the notify configuration.
    tierUpgradeStatus NotifyConfigurationTierUpgradeStatus
    The tier upgrade status of the notify configuration.
    createdTimestamp string
    The time when the notify configuration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    notifyConfigurationArn string
    The Amazon Resource Name (ARN) for the notify configuration.
    notifyConfigurationId string
    The unique identifier for the notify configuration.
    status NotifyConfigurationStatus
    The current status of the notify configuration.
    tier NotifyConfigurationTier
    The tier of the notify configuration.
    tierUpgradeStatus NotifyConfigurationTierUpgradeStatus
    The tier upgrade status of the notify configuration.
    created_timestamp str
    The time when the notify configuration was created.
    id str
    The provider-assigned unique ID for this managed resource.
    notify_configuration_arn str
    The Amazon Resource Name (ARN) for the notify configuration.
    notify_configuration_id str
    The unique identifier for the notify configuration.
    status NotifyConfigurationStatus
    The current status of the notify configuration.
    tier NotifyConfigurationTier
    The tier of the notify configuration.
    tier_upgrade_status NotifyConfigurationTierUpgradeStatus
    The tier upgrade status of the notify configuration.
    createdTimestamp String
    The time when the notify configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    notifyConfigurationArn String
    The Amazon Resource Name (ARN) for the notify configuration.
    notifyConfigurationId String
    The unique identifier for the notify configuration.
    status "PENDING" | "ACTIVE" | "REJECTED" | "REQUIRES_VERIFICATION"
    The current status of the notify configuration.
    tier "BASIC" | "ADVANCED"
    The tier of the notify configuration.
    tierUpgradeStatus "BASIC" | "PENDING_UPGRADE" | "ADVANCED" | "REJECTED"
    The tier upgrade status of the notify configuration.

    Look up Existing NotifyConfiguration Resource

    Get an existing NotifyConfiguration 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>, opts?: CustomResourceOptions): NotifyConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> NotifyConfiguration
    func GetNotifyConfiguration(ctx *Context, name string, id IDInput, state *NotifyConfigurationState, opts ...ResourceOption) (*NotifyConfiguration, error)
    public static NotifyConfiguration Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static NotifyConfiguration get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingNotifyConfiguration:    type: aws-native:smsvoice:NotifyConfiguration    get:      id: ${id}
    import {
      to = aws-native_smsvoice_notify_configuration.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state NotifyConfigurationState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    NotifyConfigurationEnabledChannelsItem

    NameValue
    SmsSMS
    VoiceVOICE
    MmsMMS
    RcsRCS
    NameValue
    NotifyConfigurationEnabledChannelsItemSmsSMS
    NotifyConfigurationEnabledChannelsItemVoiceVOICE
    NotifyConfigurationEnabledChannelsItemMmsMMS
    NotifyConfigurationEnabledChannelsItemRcsRCS
    Value
    SMS
    VOICE
    MMS
    RCS
    NameValue
    SmsSMS
    VoiceVOICE
    MmsMMS
    RcsRCS
    NameValue
    SmsSMS
    VoiceVOICE
    MmsMMS
    RcsRCS
    NameValue
    SMSSMS
    VOICEVOICE
    MMSMMS
    RCSRCS
    Value
    SMS
    VOICE
    MMS
    RCS

    NotifyConfigurationStatus

    The current status of the notify configuration.

    NameValue
    PendingPENDING
    ActiveACTIVE
    RejectedREJECTED
    RequiresVerificationREQUIRES_VERIFICATION
    NameValue
    NotifyConfigurationStatusPendingPENDING
    NotifyConfigurationStatusActiveACTIVE
    NotifyConfigurationStatusRejectedREJECTED
    NotifyConfigurationStatusRequiresVerificationREQUIRES_VERIFICATION
    Value
    PENDING
    ACTIVE
    REJECTED
    REQUIRES_VERIFICATION
    NameValue
    PendingPENDING
    ActiveACTIVE
    RejectedREJECTED
    RequiresVerificationREQUIRES_VERIFICATION
    NameValue
    PendingPENDING
    ActiveACTIVE
    RejectedREJECTED
    RequiresVerificationREQUIRES_VERIFICATION
    NameValue
    PENDINGPENDING
    ACTIVEACTIVE
    REJECTEDREJECTED
    REQUIRES_VERIFICATIONREQUIRES_VERIFICATION
    Value
    PENDING
    ACTIVE
    REJECTED
    REQUIRES_VERIFICATION

    NotifyConfigurationTier

    The tier of the notify configuration.

    NameValue
    BasicBASIC
    AdvancedADVANCED
    NameValue
    NotifyConfigurationTierBasicBASIC
    NotifyConfigurationTierAdvancedADVANCED
    Value
    BASIC
    ADVANCED
    NameValue
    BasicBASIC
    AdvancedADVANCED
    NameValue
    BasicBASIC
    AdvancedADVANCED
    NameValue
    BASICBASIC
    ADVANCEDADVANCED
    Value
    BASIC
    ADVANCED

    NotifyConfigurationTierUpgradeStatus

    The tier upgrade status of the notify configuration.

    NameValue
    BasicBASIC
    PendingUpgradePENDING_UPGRADE
    AdvancedADVANCED
    RejectedREJECTED
    NameValue
    NotifyConfigurationTierUpgradeStatusBasicBASIC
    NotifyConfigurationTierUpgradeStatusPendingUpgradePENDING_UPGRADE
    NotifyConfigurationTierUpgradeStatusAdvancedADVANCED
    NotifyConfigurationTierUpgradeStatusRejectedREJECTED
    Value
    BASIC
    PENDING_UPGRADE
    ADVANCED
    REJECTED
    NameValue
    BasicBASIC
    PendingUpgradePENDING_UPGRADE
    AdvancedADVANCED
    RejectedREJECTED
    NameValue
    BasicBASIC
    PendingUpgradePENDING_UPGRADE
    AdvancedADVANCED
    RejectedREJECTED
    NameValue
    BASICBASIC
    PENDING_UPGRADEPENDING_UPGRADE
    ADVANCEDADVANCED
    REJECTEDREJECTED
    Value
    BASIC
    PENDING_UPGRADE
    ADVANCED
    REJECTED

    NotifyConfigurationUseCase

    The use case for the notify configuration.

    NameValue
    CodeVerificationCODE_VERIFICATION
    NameValue
    NotifyConfigurationUseCaseCodeVerificationCODE_VERIFICATION
    Value
    CODE_VERIFICATION
    NameValue
    CodeVerificationCODE_VERIFICATION
    NameValue
    CodeVerificationCODE_VERIFICATION
    NameValue
    CODE_VERIFICATIONCODE_VERIFICATION
    Value
    CODE_VERIFICATION

    Tag, TagArgs

    A set of tags to apply to the resource.

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

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial