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
@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)
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
- 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.
- 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.
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
[]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.
- 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:
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.
func GetNotifyConfiguration(ctx *Context, name string, id IDInput, state *NotifyConfigurationState, opts ...ResourceOption) (*NotifyConfiguration, error)
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
| Name | Value |
|---|
| Sms | SMS |
| Voice | VOICE |
| Mms | MMS |
| Rcs | RCS |
| Name | Value |
|---|
| NotifyConfigurationEnabledChannelsItemSms | SMS |
| NotifyConfigurationEnabledChannelsItemVoice | VOICE |
| NotifyConfigurationEnabledChannelsItemMms | MMS |
| NotifyConfigurationEnabledChannelsItemRcs | RCS |
| Name | Value |
|---|
| Sms | SMS |
| Voice | VOICE |
| Mms | MMS |
| Rcs | RCS |
| Name | Value |
|---|
| Sms | SMS |
| Voice | VOICE |
| Mms | MMS |
| Rcs | RCS |
| Name | Value |
|---|
| SMS | SMS |
| VOICE | VOICE |
| MMS | MMS |
| RCS | RCS |
NotifyConfigurationStatus
The current status of the notify configuration.
| Name | Value |
|---|
| Pending | PENDING |
| Active | ACTIVE |
| Rejected | REJECTED |
| RequiresVerification | REQUIRES_VERIFICATION |
| Name | Value |
|---|
| NotifyConfigurationStatusPending | PENDING |
| NotifyConfigurationStatusActive | ACTIVE |
| NotifyConfigurationStatusRejected | REJECTED |
| NotifyConfigurationStatusRequiresVerification | REQUIRES_VERIFICATION |
| Value |
|---|
PENDING |
ACTIVE |
REJECTED |
REQUIRES_VERIFICATION |
| Name | Value |
|---|
| Pending | PENDING |
| Active | ACTIVE |
| Rejected | REJECTED |
| RequiresVerification | REQUIRES_VERIFICATION |
| Name | Value |
|---|
| Pending | PENDING |
| Active | ACTIVE |
| Rejected | REJECTED |
| RequiresVerification | REQUIRES_VERIFICATION |
| Name | Value |
|---|
| PENDING | PENDING |
| ACTIVE | ACTIVE |
| REJECTED | REJECTED |
| REQUIRES_VERIFICATION | REQUIRES_VERIFICATION |
| Value |
|---|
PENDING |
ACTIVE |
REJECTED |
REQUIRES_VERIFICATION |
NotifyConfigurationTier
The tier of the notify configuration.
| Name | Value |
|---|
| Basic | BASIC |
| Advanced | ADVANCED |
| Name | Value |
|---|
| NotifyConfigurationTierBasic | BASIC |
| NotifyConfigurationTierAdvanced | ADVANCED |
| Name | Value |
|---|
| Basic | BASIC |
| Advanced | ADVANCED |
| Name | Value |
|---|
| Basic | BASIC |
| Advanced | ADVANCED |
| Name | Value |
|---|
| BASIC | BASIC |
| ADVANCED | ADVANCED |
NotifyConfigurationTierUpgradeStatus
The tier upgrade status of the notify configuration.
| Name | Value |
|---|
| Basic | BASIC |
| PendingUpgrade | PENDING_UPGRADE |
| Advanced | ADVANCED |
| Rejected | REJECTED |
| Name | Value |
|---|
| NotifyConfigurationTierUpgradeStatusBasic | BASIC |
| NotifyConfigurationTierUpgradeStatusPendingUpgrade | PENDING_UPGRADE |
| NotifyConfigurationTierUpgradeStatusAdvanced | ADVANCED |
| NotifyConfigurationTierUpgradeStatusRejected | REJECTED |
| Value |
|---|
BASIC |
PENDING_UPGRADE |
ADVANCED |
REJECTED |
| Name | Value |
|---|
| Basic | BASIC |
| PendingUpgrade | PENDING_UPGRADE |
| Advanced | ADVANCED |
| Rejected | REJECTED |
| Name | Value |
|---|
| Basic | BASIC |
| PendingUpgrade | PENDING_UPGRADE |
| Advanced | ADVANCED |
| Rejected | REJECTED |
| Name | Value |
|---|
| BASIC | BASIC |
| PENDING_UPGRADE | PENDING_UPGRADE |
| ADVANCED | ADVANCED |
| REJECTED | REJECTED |
| Value |
|---|
BASIC |
PENDING_UPGRADE |
ADVANCED |
REJECTED |
NotifyConfigurationUseCase
The use case for the notify configuration.
| Name | Value |
|---|
| CodeVerification | CODE_VERIFICATION |
| Name | Value |
|---|
| NotifyConfigurationUseCaseCodeVerification | CODE_VERIFICATION |
| Name | Value |
|---|
| CodeVerification | CODE_VERIFICATION |
| Name | Value |
|---|
| CodeVerification | CODE_VERIFICATION |
| Name | Value |
|---|
| CODE_VERIFICATION | 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