class CfnMessageTemplatePropsMixin
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins.CfnMessageTemplatePropsMixin |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awswisdom/mixins#CfnMessageTemplatePropsMixin |
Java | software.amazon.awscdk.mixins.preview.services.wisdom.mixins.CfnMessageTemplatePropsMixin |
Python | aws_cdk.mixins_preview.aws_wisdom.mixins.CfnMessageTemplatePropsMixin |
TypeScript | @aws-cdk/mixins-preview » aws_wisdom » mixins » CfnMessageTemplatePropsMixin |
Implements
IMixin
Extends
Mixin
Creates an Amazon Q in Connect message template.
The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as wisdom_mixins } from '@aws-cdk/mixins-preview/aws-wisdom';
const cfnMessageTemplatePropsMixin = new wisdom_mixins.CfnMessageTemplatePropsMixin({
channelSubtype: 'channelSubtype',
content: {
emailMessageTemplateContent: {
body: {
html: {
content: 'content',
},
plainText: {
content: 'content',
},
},
headers: [{
name: 'name',
value: 'value',
}],
subject: 'subject',
},
smsMessageTemplateContent: {
body: {
plainText: {
content: 'content',
},
},
},
},
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'],
},
knowledgeBaseArn: 'knowledgeBaseArn',
language: 'language',
messageTemplateAttachments: [{
attachmentId: 'attachmentId',
attachmentName: 'attachmentName',
s3PresignedUrl: 's3PresignedUrl',
}],
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
}, /* all optional props */ {
strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});
Initializer
new CfnMessageTemplatePropsMixin(props: CfnMessageTemplateMixinProps, options?: CfnPropertyMixinOptions)
Parameters
- props
Cfn— L1 properties to apply.Message Template Mixin Props - options
Cfn— Mixin options.Property Mixin Options
Create a mixin to apply properties to AWS::Wisdom::MessageTemplate.
Properties
| Name | Type | Description |
|---|---|---|
| props | Cfn | |
| strategy | Property | |
| static CFN_PROPERTY_KEYS | string[] |
props
Type:
Cfn
strategy
Type:
Property
static CFN_PROPERTY_KEYS
Type:
string[]
Methods
| Name | Description |
|---|---|
| apply | Apply the mixin properties to the construct. |
| supports(construct) | Check if this mixin supports the given construct. |
applyTo(construct)
public applyTo(construct: IConstruct): IConstruct
Parameters
- construct
IConstruct
Returns
Apply the mixin properties to the construct.
supports(construct)
public supports(construct: IConstruct): boolean
Parameters
- construct
IConstruct
Returns
boolean
Check if this mixin supports the given construct.

.NET
Go
Java
Python
TypeScript