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

Interface CfnMessageTemplateMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMessageTemplateMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.304Z")
@Stability(Stable)
public interface CfnMessageTemplateMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnMessageTemplatePropsMixin.

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.*;
 CfnMessageTemplateMixinProps cfnMessageTemplateMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMessageTemplateMixinProps.Builder	A builder for CfnMessageTemplateMixinProps
static final class	CfnMessageTemplateMixinProps.Jsii$Proxy	An implementation for CfnMessageTemplateMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnMessageTemplateMixinProps.Builder	builder()
default String	getChannelSubtype()	The channel subtype this message template applies to.
default Object	getContent()	The content of the message template.
default Object	getDefaultAttributes()	An object that specifies the default values to use for variables in the message template.
default String	getDescription()	The description of the message template.
default Object	getGroupingConfiguration()	The configuration information of the external data source.
default String	getKnowledgeBaseArn()	The Amazon Resource Name (ARN) of the knowledge base.
default String	getLanguage()	The language code value for the language in which the quick response is written.
default Object	getMessageTemplateAttachments()	List of message template attachments.
default String	getName()	The name of the message template.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelSubtype

@Stability(Stable)
@Nullable
default String getChannelSubtype()

The channel subtype this message template applies to.

See Also:

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

getContent

@Stability(Stable)
@Nullable
default Object getContent()

The content of the message template.

Returns union: either IResolvable or CfnMessageTemplatePropsMixin.ContentProperty

See Also:

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

getDefaultAttributes

@Stability(Stable)
@Nullable
default Object getDefaultAttributes()

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.

Returns union: either IResolvable or CfnMessageTemplatePropsMixin.MessageTemplateAttributesProperty

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the message template.

See Also:

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

getGroupingConfiguration

@Stability(Stable)
@Nullable
default Object getGroupingConfiguration()

The configuration information of the external data source.

Returns union: either IResolvable or CfnMessageTemplatePropsMixin.GroupingConfigurationProperty

See Also:

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

getKnowledgeBaseArn

@Stability(Stable)
@Nullable
default String getKnowledgeBaseArn()

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

See Also:

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

getLanguage

@Stability(Stable)
@Nullable
default String getLanguage()

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

See Also:

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

getMessageTemplateAttachments

@Stability(Stable)
@Nullable
default Object getMessageTemplateAttachments()

List of message template attachments.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMessageTemplatePropsMixin.MessageTemplateAttachmentProperty>

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the message template.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnMessageTemplateMixinProps.Builder builder()

Returns:

a CfnMessageTemplateMixinProps.Builder of CfnMessageTemplateMixinProps