AWS::Wisdom::MessageTemplate - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Wisdom::MessageTemplate

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Wisdom::MessageTemplate",
  "Properties" : {
      "ChannelSubtype" : String,
      "Content" : Content,
      "DefaultAttributes" : MessageTemplateAttributes,
      "Description" : String,
      "GroupingConfiguration" : GroupingConfiguration,
      "KnowledgeBaseArn" : String,
      "Language" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Wisdom::MessageTemplate
Properties:
  ChannelSubtype: String
  Content: 
    Content
  DefaultAttributes: 
    MessageTemplateAttributes
  Description: String
  GroupingConfiguration: 
    GroupingConfiguration
  KnowledgeBaseArn: String
  Language: String
  Name: String
  Tags: 
    - Tag

Properties

ChannelSubtype

The channel subtype this message template applies to.

Required: Yes

Type: String

Allowed values: EMAIL | SMS

Update requires: Replacement

Content

The content of the message template.

Required: Yes

Type: Content

Update requires: No interruption

DefaultAttributes

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.

Required: No

Type: MessageTemplateAttributes

Update requires: No interruption

Description

The description of the message template.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: No interruption

GroupingConfiguration

The configuration information of the external data source.

Required: No

Type: GroupingConfiguration

Update requires: No interruption

KnowledgeBaseArn

The Amazon Resource Name (ARN) of the knowledge base.

Required: Yes

Type: String

Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$

Update requires: Replacement

Language

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

Required: No

Type: String

Minimum: 2

Maximum: 5

Update requires: No interruption

Name

The name of the message template.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9\\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: No interruption

Tags

The tags used to organize, track, or control access for this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

MessageTemplateArn

The Amazon Resource Name (ARN) of the message template.

MessageTemplateContentSha256

The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.

MessageTemplateId

The identifier of the message template.