Interface CfnBot.DialogCodeHookInvocationSettingProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBot.DialogCodeHookInvocationSettingProperty.Jsii$Proxy
- Enclosing class:
CfnBot
@Stability(Stable)
public static interface CfnBot.DialogCodeHookInvocationSettingProperty
extends software.amazon.jsii.JsiiSerializable
Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
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_; DialogCodeHookInvocationSettingProperty dialogCodeHookInvocationSettingProperty = DialogCodeHookInvocationSettingProperty.builder() .enableCodeHookInvocation(false) .isActive(false) .postCodeHookSpecification(PostDialogCodeHookInvocationSpecificationProperty.builder() .failureConditional(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()) .failureNextStep(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()) .failureResponse(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()) .successConditional(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()) .successNextStep(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()) .successResponse(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()) .timeoutConditional(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()) .timeoutNextStep(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()) .timeoutResponse(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()) // the properties below are optional .invocationLabel("invocationLabel") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBot.DialogCodeHookInvocationSettingProperty
static final class
An implementation forCfnBot.DialogCodeHookInvocationSettingProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Indicates whether a Lambda function should be invoked for the dialog.default String
A label that indicates the dialog step from which the dialog code hook is happening.Determines whether a dialog code hook is used when the intent is activated.Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEnableCodeHookInvocation
Indicates whether a Lambda function should be invoked for the dialog. -
getIsActive
Determines whether a dialog code hook is used when the intent is activated. -
getPostCodeHookSpecification
Contains the responses and actions that Amazon Lex takes after the Lambda function is complete. -
getInvocationLabel
A label that indicates the dialog step from which the dialog code hook is happening. -
builder
-