AWS CDK Reference

Appearance

v2.274.0

CfnNotifyConfigurationProps Struct Added in v2.274.0 ​

Properties for defining a CfnNotifyConfiguration.

Source
Generated code
Type last changed
v2.274.0 · 20 Oct 2026

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 ​

defaultTemplateIdstringdefault_template_idstrdefaultTemplateIdStringDefaultTemplateIdstringDefaultTemplateId*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.

deletionProtectionEnabledboolean | IResolvabledeletion_protection_enabledtyping.Union[bool, IResolvable]deletionProtectionEnabledBooleanDeletionProtectionEnabledboolDeletionProtectionEnabledinterface{}#
By default this is set to false.

When set to true the notify configuration can't be deleted.

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*stringrequired#
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.

enabledCountriesstring[]enabled_countriestyping.List[str]enabledCountriesList<String>EnabledCountriesstring[]EnabledCountries*[]*string#
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
poolIdstringpool_idstrpoolIdStringPoolIdstringPoolId*string#
The identifier of the pool to associate with the notify configuration.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
An array of tags (key and value pairs) associated with the notify configuration.
useCasestringuse_casestruseCaseStringUseCasestringUseCase*stringrequired#
The use case for the notify configuration.