CfnMessageTemplateProps Struct
Properties for defining a CfnMessageTemplate.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wisdom as wisdom } from 'aws-cdk-lib';
const cfnMessageTemplateProps: wisdom.CfnMessageTemplateProps = {
channelSubtype: 'channelSubtype',
content: {
emailMessageTemplateContent: {
body: {
html: {
content: 'content',
},
plainText: {
content: 'content',
},
},
headers: [{
name: 'name',
value: 'value',
}],
subject: 'subject',
},
smsMessageTemplateContent: {
body: {
plainText: {
content: 'content',
},
},
},
},
knowledgeBaseArn: 'knowledgeBaseArn',
name: 'name',
// the properties below are optional
defaultAttributes: {
agentAttributes: {
firstName: 'firstName',
lastName: 'lastName',
},
customAttributes: {
customAttributesKey: 'customAttributes',
},
customerProfileAttributes: {
accountNumber: 'accountNumber',
additionalInformation: 'additionalInformation',
address1: 'address1',
address2: 'address2',
address3: 'address3',
address4: 'address4',
billingAddress1: 'billingAddress1',
billingAddress2: 'billingAddress2',
billingAddress3: 'billingAddress3',
billingAddress4: 'billingAddress4',
billingCity: 'billingCity',
billingCountry: 'billingCountry',
billingCounty: 'billingCounty',
billingPostalCode: 'billingPostalCode',
billingProvince: 'billingProvince',
billingState: 'billingState',
birthDate: 'birthDate',
businessEmailAddress: 'businessEmailAddress',
businessName: 'businessName',
businessPhoneNumber: 'businessPhoneNumber',
city: 'city',
country: 'country',
county: 'county',
custom: {
customKey: 'custom',
},
emailAddress: 'emailAddress',
firstName: 'firstName',
gender: 'gender',
homePhoneNumber: 'homePhoneNumber',
lastName: 'lastName',
mailingAddress1: 'mailingAddress1',
mailingAddress2: 'mailingAddress2',
mailingAddress3: 'mailingAddress3',
mailingAddress4: 'mailingAddress4',
mailingCity: 'mailingCity',
mailingCountry: 'mailingCountry',
mailingCounty: 'mailingCounty',
mailingPostalCode: 'mailingPostalCode',
mailingProvince: 'mailingProvince',
mailingState: 'mailingState',
middleName: 'middleName',
mobilePhoneNumber: 'mobilePhoneNumber',
partyType: 'partyType',
phoneNumber: 'phoneNumber',
postalCode: 'postalCode',
profileArn: 'profileArn',
profileId: 'profileId',
province: 'province',
shippingAddress1: 'shippingAddress1',
shippingAddress2: 'shippingAddress2',
shippingAddress3: 'shippingAddress3',
shippingAddress4: 'shippingAddress4',
shippingCity: 'shippingCity',
shippingCountry: 'shippingCountry',
shippingCounty: 'shippingCounty',
shippingPostalCode: 'shippingPostalCode',
shippingProvince: 'shippingProvince',
shippingState: 'shippingState',
state: 'state',
},
systemAttributes: {
customerEndpoint: {
address: 'address',
},
name: 'name',
systemEndpoint: {
address: 'address',
},
},
},
description: 'description',
groupingConfiguration: {
criteria: 'criteria',
values: ['values'],
},
language: 'language',
messageTemplateAttachments: [{
attachmentName: 'attachmentName',
s3PresignedUrl: 's3PresignedUrl',
// the properties below are optional
attachmentId: 'attachmentId',
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
channelSubtypestringchannel_subtypestrchannelSubtypeStringChannelSubtypestringChannelSubtype*stringrequired#The channel subtype this message template applies to.
contentIResolvable | CfnMessageTemplate.ContentPropertycontenttyping.Union[IResolvable, ContentProperty]contentIResolvableContentIResolvableContentinterface{}required#The content of the message template.
defaultAttributesoptionalIResolvable | CfnMessageTemplate.MessageTemplateAttributesPropertydefault_attributesoptionaltyping.Union[IResolvable, MessageTemplateAttributesProperty]defaultAttributesoptionalIResolvableDefaultAttributesoptionalIResolvableDefaultAttributesoptionalinterface{}#An object that specifies the default values to use for variables in the message template.
This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description of the message template.
groupingConfigurationoptionalIResolvable | CfnMessageTemplate.GroupingConfigurationPropertygrouping_configurationoptionaltyping.Union[IResolvable, GroupingConfigurationProperty]groupingConfigurationoptionalIResolvableGroupingConfigurationoptionalIResolvableGroupingConfigurationoptionalinterface{}#The configuration information of the external data source.
knowledgeBaseArnstringknowledge_base_arnstrknowledgeBaseArnStringKnowledgeBaseArnstringKnowledgeBaseArn*stringrequired#The Amazon Resource Name (ARN) of the knowledge base.
languageoptionalstringlanguageoptionalstrlanguageoptionalStringLanguageoptionalstringLanguageoptional*string#The language code value for the language in which the quick response is written.
The supported language codes include de_DE , en_US , es_ES , fr_FR , id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
messageTemplateAttachmentsoptionalIResolvable | IResolvable | CfnMessageTemplate.MessageTemplateAttachmentProperty[]message_template_attachmentsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MessageTemplateAttachmentProperty]]]messageTemplateAttachmentsoptionalIResolvableMessageTemplateAttachmentsoptionalIResolvableMessageTemplateAttachmentsoptionalinterface{}#List of message template attachments.
The name of the message template.