software.amazon.awscdk.services.lex

Interface CfnBot.FulfillmentStartResponseSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.FulfillmentStartResponseSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnBot

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

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

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.*;
 FulfillmentStartResponseSpecificationProperty fulfillmentStartResponseSpecificationProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBot.FulfillmentStartResponseSpecificationProperty.Builder	builder()
default Object	getAllowInterrupt() Determines whether the user can interrupt the start message while it is playing.
Number	getDelayInSeconds() The delay between when the Lambda fulfillment function starts running and the start message is played.
Object	getMessageGroups() One to 5 message groups that contain start messages.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDelayInSeconds

@Stability(value=Stable)
 @NotNull
Number getDelayInSeconds()

The delay between when the Lambda fulfillment function starts running and the start message is played.

If the Lambda function returns before the delay is over, the start message isn't played.

getMessageGroups

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

One to 5 message groups that contain start messages.

Amazon Lex chooses one of the messages to play to the user.

getAllowInterrupt

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

Determines whether the user can interrupt the start message while it is playing.

builder

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

Returns:

a CfnBot.FulfillmentStartResponseSpecificationProperty.Builder of CfnBot.FulfillmentStartResponseSpecificationProperty