aws-cdk-lib.aws_lex.CfnBot.MessageProperty

interface MessageProperty

LanguageType name
.NETAmazon.CDK.AWS.Lex.CfnBot.MessageProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_MessageProperty
Javasoftware.amazon.awscdk.services.lex.CfnBot.MessageProperty
Pythonaws_cdk.aws_lex.CfnBot.MessageProperty
TypeScript aws-cdk-lib » aws_lex » CfnBot » MessageProperty

The object that provides message text and its type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
const messageProperty: lex.CfnBot.MessageProperty = {
  customPayload: {
    value: 'value',
  },
  imageResponseCard: {
    title: 'title',

    // the properties below are optional
    buttons: [{
      text: 'text',
      value: 'value',
    }],
    imageUrl: 'imageUrl',
    subtitle: 'subtitle',
  },
  plainTextMessage: {
    value: 'value',
  },
  ssmlMessage: {
    value: 'value',
  },
};

Properties

NameTypeDescription
customPayload?IResolvable | CustomPayloadPropertyA message in a custom format defined by the client application.
imageResponseCard?IResolvable | ImageResponseCardPropertyA message that defines a response card that the client application can show to the user.
plainTextMessage?IResolvable | PlainTextMessagePropertyA message in plain text format.
ssmlMessage?IResolvable | SSMLMessagePropertyA message in Speech Synthesis Markup Language (SSML).

customPayload?

Type: IResolvable | CustomPayloadProperty (optional)

A message in a custom format defined by the client application.


imageResponseCard?

Type: IResolvable | ImageResponseCardProperty (optional)

A message that defines a response card that the client application can show to the user.


plainTextMessage?

Type: IResolvable | PlainTextMessageProperty (optional)

A message in plain text format.


ssmlMessage?

Type: IResolvable | SSMLMessageProperty (optional)

A message in Speech Synthesis Markup Language (SSML).