Package software.amazon.awscdk.services.wisdom

Class CfnMessageTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wisdom.CfnMessageTemplate
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMessageTemplateRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:47.499Z") @Stability(Stable) public class CfnMessageTemplate extends CfnResource implements IInspectable, IMessageTemplateRef, ITaggableV2
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.services.wisdom.*;
 CfnMessageTemplate cfnMessageTemplate = CfnMessageTemplate.Builder.create(this, "MyCfnMessageTemplate")
         .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())
         .knowledgeBaseArn("knowledgeBaseArn")
         .name("name")
         // the properties below are optional
         .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())
         .language("language")
         .messageTemplateAttachments(List.of(MessageTemplateAttachmentProperty.builder()
                 .attachmentName("attachmentName")
                 .s3PresignedUrl("s3PresignedUrl")
                 // the properties below are optional
                 .attachmentId("attachmentId")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMessageTemplate

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

    • CfnMessageTemplate

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

    • CfnMessageTemplate

      @Stability(Stable) public CfnMessageTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMessageTemplateProps props)
      Create a new AWS::Wisdom::MessageTemplate.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForMessageTemplate

      @Stability(Stable) @NotNull public static String arnForMessageTemplate(@NotNull IMessageTemplateRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnMessageTemplate

      @Stability(Stable) @NotNull public static Boolean isCfnMessageTemplate(@NotNull Object x)
      Checks whether the given object is a CfnMessageTemplate.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrMessageTemplateArn

      @Stability(Stable) @NotNull public String getAttrMessageTemplateArn()
      The Amazon Resource Name (ARN) of the message template.

    • getAttrMessageTemplateContentSha256

      @Stability(Stable) @NotNull public String getAttrMessageTemplateContentSha256()
      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.

    • getAttrMessageTemplateId

      @Stability(Stable) @NotNull public String getAttrMessageTemplateId()
      The identifier of the message template.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMessageTemplateRef

      @Stability(Stable) @NotNull public MessageTemplateReference getMessageTemplateRef()
      A reference to a MessageTemplate resource.
      Specified by:
      getMessageTemplateRef in interface IMessageTemplateRef

    • getChannelSubtype

      @Stability(Stable) @NotNull public String getChannelSubtype()
      The channel subtype this message template applies to.

    • setChannelSubtype

      @Stability(Stable) public void setChannelSubtype(@NotNull String value)
      The channel subtype this message template applies to.

    • getContent

      @Stability(Stable) @NotNull public Object getContent()
      The content of the message template.

      Returns union: either IResolvable or CfnMessageTemplate.ContentProperty

    • setContent

      @Stability(Stable) public void setContent(@NotNull IResolvable value)
      The content of the message template.

    • setContent

      @Stability(Stable) public void setContent(@NotNull CfnMessageTemplate.ContentProperty value)
      The content of the message template.

    • getKnowledgeBaseArn

      @Stability(Stable) @NotNull public String getKnowledgeBaseArn()
      The Amazon Resource Name (ARN) of the knowledge base.

    • setKnowledgeBaseArn

      @Stability(Stable) public void setKnowledgeBaseArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the knowledge base.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the message template.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the message template.

    • getDefaultAttributes

      @Stability(Stable) @Nullable public Object getDefaultAttributes()
      An object that specifies the default values to use for variables in the message template.

      Returns union: either IResolvable or CfnMessageTemplate.MessageTemplateAttributesProperty

    • setDefaultAttributes

      @Stability(Stable) public void setDefaultAttributes(@Nullable IResolvable value)
      An object that specifies the default values to use for variables in the message template.

    • setDefaultAttributes

      @Stability(Stable) public void setDefaultAttributes(@Nullable CfnMessageTemplate.MessageTemplateAttributesProperty value)
      An object that specifies the default values to use for variables in the message template.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the message template.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the message template.

    • getGroupingConfiguration

      @Stability(Stable) @Nullable public Object getGroupingConfiguration()
      The configuration information of the external data source.

      Returns union: either IResolvable or CfnMessageTemplate.GroupingConfigurationProperty

    • setGroupingConfiguration

      @Stability(Stable) public void setGroupingConfiguration(@Nullable IResolvable value)
      The configuration information of the external data source.

    • setGroupingConfiguration

      @Stability(Stable) public void setGroupingConfiguration(@Nullable CfnMessageTemplate.GroupingConfigurationProperty value)
      The configuration information of the external data source.

    • getLanguage

      @Stability(Stable) @Nullable public String getLanguage()
      The language code value for the language in which the quick response is written.

    • setLanguage

      @Stability(Stable) public void setLanguage(@Nullable String value)
      The language code value for the language in which the quick response is written.

    • getMessageTemplateAttachments

      @Stability(Stable) @Nullable public Object getMessageTemplateAttachments()
      List of message template attachments.

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

    • setMessageTemplateAttachments

      @Stability(Stable) public void setMessageTemplateAttachments(@Nullable IResolvable value)
      List of message template attachments.

    • setMessageTemplateAttachments

      @Stability(Stable) public void setMessageTemplateAttachments(@Nullable List<Object> value)
      List of message template attachments.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.