Package software.amazon.awscdk.cfnpropertymixins.services.wisdom

Class CfnMessageTemplatePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.wisdom.CfnMessageTemplatePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.305Z")
@Stability(Stable)
public class CfnMessageTemplatePropsMixin
extends Mixin
implements software.constructs.IMixin

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 software.amazon.awscdk.cfnpropertymixins.services.wisdom.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnMessageTemplatePropsMixin cfnMessageTemplatePropsMixin = CfnMessageTemplatePropsMixin.Builder.create(CfnMessageTemplateMixinProps.builder()
         .channelSubtype("channelSubtype")
         .content(ContentProperty.builder()
                 .emailMessageTemplateContent(EmailMessageTemplateContentProperty.builder()
                         .body(EmailMessageTemplateContentBodyProperty.builder()
                                 .html(MessageTemplateBodyContentProviderProperty.builder()
                                         .content("content")
                                         .build())
                                 .plainText(MessageTemplateBodyContentProviderProperty.builder()
                                         .content("content")
                                         .build())
                                 .build())
                         .headers(List.of(EmailMessageTemplateHeaderProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .subject("subject")
                         .build())
                 .smsMessageTemplateContent(SmsMessageTemplateContentProperty.builder()
                         .body(SmsMessageTemplateContentBodyProperty.builder()
                                 .plainText(MessageTemplateBodyContentProviderProperty.builder()
                                         .content("content")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .defaultAttributes(MessageTemplateAttributesProperty.builder()
                 .agentAttributes(AgentAttributesProperty.builder()
                         .firstName("firstName")
                         .lastName("lastName")
                         .build())
                 .customAttributes(Map.of(
                         "customAttributesKey", "customAttributes"))
                 .customerProfileAttributes(CustomerProfileAttributesProperty.builder()
                         .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(Map.of(
                                 "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")
                         .build())
                 .systemAttributes(SystemAttributesProperty.builder()
                         .customerEndpoint(SystemEndpointAttributesProperty.builder()
                                 .address("address")
                                 .build())
                         .name("name")
                         .systemEndpoint(SystemEndpointAttributesProperty.builder()
                                 .address("address")
                                 .build())
                         .build())
                 .build())
         .description("description")
         .groupingConfiguration(GroupingConfigurationProperty.builder()
                 .criteria("criteria")
                 .values(List.of("values"))
                 .build())
         .knowledgeBaseArn("knowledgeBaseArn")
         .language("language")
         .messageTemplateAttachments(List.of(MessageTemplateAttachmentProperty.builder()
                 .attachmentId("attachmentId")
                 .attachmentName("attachmentName")
                 .s3PresignedUrl("s3PresignedUrl")
                 .build()))
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnMessageTemplatePropsMixin.AgentAttributesProperty	Information about an agent.
static final class	CfnMessageTemplatePropsMixin.Builder	A fluent builder for CfnMessageTemplatePropsMixin.
static interface	CfnMessageTemplatePropsMixin.ContentProperty	The content of the message template.
static interface	CfnMessageTemplatePropsMixin.CustomerProfileAttributesProperty	The customer profile attributes that are used with the message template.
static interface	CfnMessageTemplatePropsMixin.EmailMessageTemplateContentBodyProperty	The body to use in email messages.
static interface	CfnMessageTemplatePropsMixin.EmailMessageTemplateContentProperty	The content of the message template that applies to the email channel subtype.
static interface	CfnMessageTemplatePropsMixin.EmailMessageTemplateHeaderProperty	The email headers to include in email messages.
static interface	CfnMessageTemplatePropsMixin.GroupingConfigurationProperty	The configuration information of the grouping of Amazon Q in Connect users.
static interface	CfnMessageTemplatePropsMixin.MessageTemplateAttachmentProperty	Information about the message template attachment.
static interface	CfnMessageTemplatePropsMixin.MessageTemplateAttributesProperty	The attributes that are used with the message template.
static interface	CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty	The container of the message template body.
static interface	CfnMessageTemplatePropsMixin.SmsMessageTemplateContentBodyProperty	The body to use in SMS messages.
static interface	CfnMessageTemplatePropsMixin.SmsMessageTemplateContentProperty	The content of the message template that applies to the SMS channel subtype.
static interface	CfnMessageTemplatePropsMixin.SystemAttributesProperty	The system attributes that are used with the message template.
static interface	CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty	The system endpoint attributes that are used with the message template.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnMessageTemplatePropsMixin(CfnMessageTemplateMixinProps props)	Create a mixin to apply properties to AWS::Wisdom::MessageTemplate.
	CfnMessageTemplatePropsMixin(CfnMessageTemplateMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Wisdom::MessageTemplate.
protected	CfnMessageTemplatePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMessageTemplatePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnMessageTemplateMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnMessageTemplatePropsMixin

protected CfnMessageTemplatePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnMessageTemplatePropsMixin

protected CfnMessageTemplatePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMessageTemplatePropsMixin

@Stability(Stable)
public CfnMessageTemplatePropsMixin(@NotNull
 CfnMessageTemplateMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Wisdom::MessageTemplate.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnMessageTemplatePropsMixin

@Stability(Stable)
public CfnMessageTemplatePropsMixin(@NotNull
 CfnMessageTemplateMixinProps props)

Create a mixin to apply properties to AWS::Wisdom::MessageTemplate.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnMessageTemplateMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()