CfnPoolProps Struct
Properties for defining a CfnPool.
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 cfnPoolProps: smsvoice.CfnPoolProps = {
mandatoryKeywords: {
help: {
message: 'message',
},
stop: {
message: 'message',
},
},
originationIdentities: ['originationIdentities'],
// the properties below are optional
deletionProtectionEnabled: false,
optionalKeywords: [{
action: 'action',
keyword: 'keyword',
message: 'message',
}],
optOutListName: 'optOutListName',
selfManagedOptOutsEnabled: false,
sharedRoutesEnabled: false,
tags: [{
key: 'key',
value: 'value',
}],
twoWay: {
enabled: false,
// the properties below are optional
channelArn: 'channelArn',
channelRole: 'channelRole',
},
};
Properties
deletionProtectionEnabledoptionalboolean | IResolvabledeletion_protection_enabledoptionaltyping.Union[bool, IResolvable]deletionProtectionEnabledoptionalBooleanDeletionProtectionEnabledoptionalboolDeletionProtectionEnabledoptionalinterface{}#When set to true the pool can't be deleted.
mandatoryKeywordsIResolvable | CfnPool.MandatoryKeywordsPropertymandatory_keywordstyping.Union[IResolvable, MandatoryKeywordsProperty]mandatoryKeywordsIResolvableMandatoryKeywordsIResolvableMandatoryKeywordsinterface{}required#Creates or updates the pool's `MandatoryKeyword` configuration.
For more information, see Keywords in the End User Messaging User Guide.
optionalKeywordsoptionalIResolvable | IResolvable | CfnPool.OptionalKeywordProperty[]optional_keywordsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OptionalKeywordProperty]]]optionalKeywordsoptionalIResolvableOptionalKeywordsoptionalIResolvableOptionalKeywordsoptionalinterface{}#Specifies any optional keywords to associate with the pool.
For more information, see Keywords in the End User Messaging User Guide.
optOutListNameoptionalstringopt_out_list_nameoptionalstroptOutListNameoptionalStringOptOutListNameoptionalstringOptOutListNameoptional*string#The name of the OptOutList associated with the pool.
originationIdentitiesstring[]origination_identitiestyping.List[str]originationIdentitiesList<String>OriginationIdentitiesstring[]OriginationIdentities*[]*stringrequired#The list of origination identities to apply to the pool, either `PhoneNumberArn` or `SenderIdArn` .
notes
For more information, see Registrations in the End User Messaging User Guide.
If you are using a shared End User Messaging resource then you must use the full Amazon Resource Name (ARN).
selfManagedOptOutsEnabledoptionalboolean | IResolvableself_managed_opt_outs_enabledoptionaltyping.Union[bool, IResolvable]selfManagedOptOutsEnabledoptionalBooleanSelfManagedOptOutsEnabledoptionalboolSelfManagedOptOutsEnabledoptionalinterface{}#When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.
notes
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. For more information see Self-managed opt-outs
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of tags (key and value pairs) associated with the pool.
twoWayoptionalIResolvable | CfnPool.TwoWayPropertytwo_wayoptionaltyping.Union[IResolvable, TwoWayProperty]twoWayoptionalIResolvableTwoWayoptionalIResolvableTwoWayoptionalinterface{}#Describes the two-way SMS configuration for a phone number.
For more information, see Two-way SMS messaging in the End User Messaging User Guide.