CfnNotifyConfigurationProps Struct
Properties for defining a CfnNotifyConfiguration.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_smsvoice as smsvoice } from 'aws-cdk-lib';
const cfnNotifyConfigurationProps: smsvoice.CfnNotifyConfigurationProps = {
displayName: 'displayName',
enabledChannels: ['enabledChannels'],
useCase: 'useCase',
// the properties below are optional
defaultTemplateId: 'defaultTemplateId',
deletionProtectionEnabled: false,
enabledCountries: ['enabledCountries'],
poolId: 'poolId',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
defaultTemplateIdoptionalstringdefault_template_idoptionalstrdefaultTemplateIdoptionalStringDefaultTemplateIdoptionalstringDefaultTemplateIdoptional*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.
deletionProtectionEnabledoptionalboolean | IResolvabledeletion_protection_enabledoptionaltyping.Union[bool, IResolvable]deletionProtectionEnabledoptionalBooleanDeletionProtectionEnabledoptionalboolDeletionProtectionEnabledoptionalinterface{}#By default this is set to false.
When set to true the notify configuration can't be deleted.
The display name to associate with the notify configuration.
enabledChannelsstring[]enabled_channelstyping.List[str]enabledChannelsList<String>EnabledChannelsstring[]EnabledChannels*[]*stringrequired#An array of channels to enable for the notify configuration.
Supported values include SMS and VOICE.
enabledCountriesoptionalstring[]enabled_countriesoptionaltyping.List[str]enabledCountriesoptionalList<String>EnabledCountriesoptionalstring[]EnabledCountriesoptional*[]*string#An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
poolIdoptionalstringpool_idoptionalstrpoolIdoptionalStringPoolIdoptionalstringPoolIdoptional*string#The identifier of the pool to associate with the notify configuration.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of tags (key and value pairs) associated with the notify configuration.
The use case for the notify configuration.