aws-cdk-lib.aws_lex.CfnBot.MessageProperty

MessageProperty Struct

The object that provides message text and its type.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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',
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lex as lex

message_property = lex.CfnBot.MessageProperty(
    custom_payload=lex.CfnBot.CustomPayloadProperty(
        value="value"
    ),
    image_response_card=lex.CfnBot.ImageResponseCardProperty(
        title="title",

        # the properties below are optional
        buttons=[lex.CfnBot.ButtonProperty(
            text="text",
            value="value"
        )],
        image_url="imageUrl",
        subtitle="subtitle"
    ),
    plain_text_message=lex.CfnBot.PlainTextMessageProperty(
        value="value"
    ),
    ssml_message=lex.CfnBot.SSMLMessageProperty(
        value="value"
    )
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lex.*;

MessageProperty messageProperty = MessageProperty.builder()
        .customPayload(CustomPayloadProperty.builder()
                .value("value")
                .build())
        .imageResponseCard(ImageResponseCardProperty.builder()
                .title("title")

                // the properties below are optional
                .buttons(List.of(ButtonProperty.builder()
                        .text("text")
                        .value("value")
                        .build()))
                .imageUrl("imageUrl")
                .subtitle("subtitle")
                .build())
        .plainTextMessage(PlainTextMessageProperty.builder()
                .value("value")
                .build())
        .ssmlMessage(SSMLMessageProperty.builder()
                .value("value")
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lex;

var messageProperty = new MessageProperty {
    CustomPayload = new CustomPayloadProperty {
        Value = "value"
    },
    ImageResponseCard = new ImageResponseCardProperty {
        Title = "title",

        // the properties below are optional
        Buttons = new [] { new ButtonProperty {
            Text = "text",
            Value = "value"
        } },
        ImageUrl = "imageUrl",
        Subtitle = "subtitle"
    },
    PlainTextMessage = new PlainTextMessageProperty {
        Value = "value"
    },
    SsmlMessage = new SSMLMessageProperty {
        Value = "value"
    }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

messageProperty := &MessageProperty{
	CustomPayload: &CustomPayloadProperty{
		Value: jsii.String("value"),
	},
	ImageResponseCard: &ImageResponseCardProperty{
		Title: jsii.String("title"),

		// the properties below are optional
		Buttons: []interface{}{
			&ButtonProperty{
				Text: jsii.String("text"),
				Value: jsii.String("value"),
			},
		},
		ImageUrl: jsii.String("imageUrl"),
		Subtitle: jsii.String("subtitle"),
	},
	PlainTextMessage: &PlainTextMessageProperty{
		Value: jsii.String("value"),
	},
	SsmlMessage: &SSMLMessageProperty{
		Value: jsii.String("value"),
	},
}

Properties

customPayload?optionalIResolvable | CfnBot.CustomPayloadPropertycustom_payload?optionaltyping.Union[IResolvable, CustomPayloadProperty]customPayload?optionalIResolvableCustomPayload?optionalIResolvableCustomPayload?optionalinterface{}#

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

imageResponseCard?optionalIResolvable | CfnBot.ImageResponseCardPropertyimage_response_card?optionaltyping.Union[IResolvable, ImageResponseCardProperty]imageResponseCard?optionalIResolvableImageResponseCard?optionalIResolvableImageResponseCard?optionalinterface{}#

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

plainTextMessage?optionalIResolvable | CfnBot.PlainTextMessagePropertyplain_text_message?optionaltyping.Union[IResolvable, PlainTextMessageProperty]plainTextMessage?optionalIResolvablePlainTextMessage?optionalIResolvablePlainTextMessage?optionalinterface{}#

A message in plain text format.

ssmlMessage?optionalIResolvable | CfnBot.SSMLMessagePropertyssml_message?optionaltyping.Union[IResolvable, SSMLMessageProperty]ssmlMessage?optionalIResolvableSsmlMessage?optionalIResolvableSsmlMessage?optionalinterface{}#

A message in Speech Synthesis Markup Language (SSML).