software.amazon.awscdk.services.lex

Interface CfnBot.FulfillmentCodeHookSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.FulfillmentCodeHookSettingProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(value=Stable)
public static interface CfnBot.FulfillmentCodeHookSettingProperty
extends software.amazon.jsii.JsiiSerializable

Determines if a Lambda function should be invoked for a specific intent.

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.*;
 FulfillmentCodeHookSettingProperty fulfillmentCodeHookSettingProperty = FulfillmentCodeHookSettingProperty.builder()
         .enabled(false)
         // the properties below are optional
         .fulfillmentUpdatesSpecification(FulfillmentUpdatesSpecificationProperty.builder()
                 .active(false)
                 // the properties below are optional
                 .startResponse(FulfillmentStartResponseSpecificationProperty.builder()
                         .delayInSeconds(123)
                         .messageGroups(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())
                 .timeoutInSeconds(123)
                 .updateResponse(FulfillmentUpdateResponseSpecificationProperty.builder()
                         .frequencyInSeconds(123)
                         .messageGroups(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())
         .postFulfillmentStatusSpecification(PostFulfillmentStatusSpecificationProperty.builder()
                 .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())
                 .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())
                 .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())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBot.FulfillmentCodeHookSettingProperty.Builder	builder()
Object	getEnabled() Indicates whether a Lambda function should be invoked for fulfill a specific intent.
default Object	getFulfillmentUpdatesSpecification() Provides settings for update messages sent to the user for long-running Lambda fulfillment functions.
default Object	getPostFulfillmentStatusSpecification() Provides settings for messages sent to the user for after the Lambda fulfillment function completes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEnabled

@Stability(value=Stable)
 @NotNull
Object getEnabled()

Indicates whether a Lambda function should be invoked for fulfill a specific intent.

getFulfillmentUpdatesSpecification

@Stability(value=Stable)
 @Nullable
default Object getFulfillmentUpdatesSpecification()

Provides settings for update messages sent to the user for long-running Lambda fulfillment functions.

Fulfillment updates can be used only with streaming conversations.

getPostFulfillmentStatusSpecification

@Stability(value=Stable)
 @Nullable
default Object getPostFulfillmentStatusSpecification()

Provides settings for messages sent to the user for after the Lambda fulfillment function completes.

Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

builder

@Stability(value=Stable)
static CfnBot.FulfillmentCodeHookSettingProperty.Builder builder()

Returns:

a CfnBot.FulfillmentCodeHookSettingProperty.Builder of CfnBot.FulfillmentCodeHookSettingProperty