Package software.amazon.awscdk.services.lex

Interface CfnBot.IntentClosingSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.IntentClosingSettingProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(Stable)
public static interface CfnBot.IntentClosingSettingProperty
extends software.amazon.jsii.JsiiSerializable

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

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.lex.*;
 SlotValueOverrideProperty slotValueOverrideProperty_;
 IntentClosingSettingProperty intentClosingSettingProperty = IntentClosingSettingProperty.builder()
         .closingResponse(ResponseSpecificationProperty.builder()
                 .messageGroupsList(List.of(MessageGroupProperty.builder()
                         .message(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())
                         // the properties below are optional
                         .variations(List.of(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()))
                         .build()))
                 // the properties below are optional
                 .allowInterrupt(false)
                 .build())
         .conditional(ConditionalSpecificationProperty.builder()
                 .conditionalBranches(List.of(ConditionalBranchProperty.builder()
                         .condition(ConditionProperty.builder()
                                 .expressionString("expressionString")
                                 .build())
                         .name("name")
                         .nextStep(DialogStateProperty.builder()
                                 .dialogAction(DialogActionProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .slotToElicit("slotToElicit")
                                         .suppressNextMessage(false)
                                         .build())
                                 .intent(IntentOverrideProperty.builder()
                                         .name("name")
                                         .slots(List.of(SlotValueOverrideMapProperty.builder()
                                                 .slotName("slotName")
                                                 .slotValueOverride(SlotValueOverrideProperty.builder()
                                                         .shape("shape")
                                                         .value(SlotValueProperty.builder()
                                                                 .interpretedValue("interpretedValue")
                                                                 .build())
                                                         .values(List.of(slotValueOverrideProperty_))
                                                         .build())
                                                 .build()))
                                         .build())
                                 .sessionAttributes(List.of(SessionAttributeProperty.builder()
                                         .key("key")
                                         // the properties below are optional
                                         .value("value")
                                         .build()))
                                 .build())
                         // the properties below are optional
                         .response(ResponseSpecificationProperty.builder()
                                 .messageGroupsList(List.of(MessageGroupProperty.builder()
                                         .message(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())
                                         // the properties below are optional
                                         .variations(List.of(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()))
                                         .build()))
                                 // the properties below are optional
                                 .allowInterrupt(false)
                                 .build())
                         .build()))
                 .defaultBranch(DefaultConditionalBranchProperty.builder()
                         .nextStep(DialogStateProperty.builder()
                                 .dialogAction(DialogActionProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .slotToElicit("slotToElicit")
                                         .suppressNextMessage(false)
                                         .build())
                                 .intent(IntentOverrideProperty.builder()
                                         .name("name")
                                         .slots(List.of(SlotValueOverrideMapProperty.builder()
                                                 .slotName("slotName")
                                                 .slotValueOverride(SlotValueOverrideProperty.builder()
                                                         .shape("shape")
                                                         .value(SlotValueProperty.builder()
                                                                 .interpretedValue("interpretedValue")
                                                                 .build())
                                                         .values(List.of(slotValueOverrideProperty_))
                                                         .build())
                                                 .build()))
                                         .build())
                                 .sessionAttributes(List.of(SessionAttributeProperty.builder()
                                         .key("key")
                                         // the properties below are optional
                                         .value("value")
                                         .build()))
                                 .build())
                         .response(ResponseSpecificationProperty.builder()
                                 .messageGroupsList(List.of(MessageGroupProperty.builder()
                                         .message(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())
                                         // the properties below are optional
                                         .variations(List.of(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()))
                                         .build()))
                                 // the properties below are optional
                                 .allowInterrupt(false)
                                 .build())
                         .build())
                 .isActive(false)
                 .build())
         .isActive(false)
         .nextStep(DialogStateProperty.builder()
                 .dialogAction(DialogActionProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .slotToElicit("slotToElicit")
                         .suppressNextMessage(false)
                         .build())
                 .intent(IntentOverrideProperty.builder()
                         .name("name")
                         .slots(List.of(SlotValueOverrideMapProperty.builder()
                                 .slotName("slotName")
                                 .slotValueOverride(SlotValueOverrideProperty.builder()
                                         .shape("shape")
                                         .value(SlotValueProperty.builder()
                                                 .interpretedValue("interpretedValue")
                                                 .build())
                                         .values(List.of(slotValueOverrideProperty_))
                                         .build())
                                 .build()))
                         .build())
                 .sessionAttributes(List.of(SessionAttributeProperty.builder()
                         .key("key")
                         // the properties below are optional
                         .value("value")
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBot.IntentClosingSettingProperty.Builder	builder()
default Object	getClosingResponse()	The response that Amazon Lex sends to the user when the intent is complete.
default Object	getConditional()	A list of conditional branches associated with the intent's closing response.
default Object	getIsActive()	Specifies whether an intent's closing response is used.
default Object	getNextStep()	Specifies the next step that the bot executes after playing the intent's closing response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClosingResponse

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

The response that Amazon Lex sends to the user when the intent is complete.

Returns union: either IResolvable or CfnBot.ResponseSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-closingresponse

getConditional

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

A list of conditional branches associated with the intent's closing response.

These branches are executed when the nextStep attribute is set to EvalutateConditional .

Returns union: either IResolvable or CfnBot.ConditionalSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-conditional

getIsActive

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

Specifies whether an intent's closing response is used.

When this field is false, the closing response isn't sent to the user. If the IsActive field isn't specified, the default is true.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-isactive

getNextStep

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

Specifies the next step that the bot executes after playing the intent's closing response.

Returns union: either IResolvable or CfnBot.DialogStateProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-nextstep

builder

@Stability(Stable)
static CfnBot.IntentClosingSettingProperty.Builder builder()

Returns:

a CfnBot.IntentClosingSettingProperty.Builder of CfnBot.IntentClosingSettingProperty