Package software.amazon.awscdk.cfnpropertymixins.services.lex

Interface CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnBotPropsMixin

@Stability(Stable)
public static interface CfnBotPropsMixin.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.cfnpropertymixins.services.lex.*;
 FulfillmentStartResponseSpecificationProperty fulfillmentStartResponseSpecificationProperty = FulfillmentStartResponseSpecificationProperty.builder()
         .allowInterrupt(false)
         .delayInSeconds(123)
         .messageGroups(List.of(MessageGroupProperty.builder()
                 .message(MessageProperty.builder()
                         .customPayload(CustomPayloadProperty.builder()
                                 .value("value")
                                 .build())
                         .imageResponseCard(ImageResponseCardProperty.builder()
                                 .buttons(List.of(ButtonProperty.builder()
                                         .text("text")
                                         .value("value")
                                         .build()))
                                 .imageUrl("imageUrl")
                                 .subtitle("subtitle")
                                 .title("title")
                                 .build())
                         .plainTextMessage(PlainTextMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .ssmlMessage(SSMLMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .build())
                 .variations(List.of(MessageProperty.builder()
                         .customPayload(CustomPayloadProperty.builder()
                                 .value("value")
                                 .build())
                         .imageResponseCard(ImageResponseCardProperty.builder()
                                 .buttons(List.of(ButtonProperty.builder()
                                         .text("text")
                                         .value("value")
                                         .build()))
                                 .imageUrl("imageUrl")
                                 .subtitle("subtitle")
                                 .title("title")
                                 .build())
                         .plainTextMessage(PlainTextMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .ssmlMessage(SSMLMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .build()))
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowInterrupt

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

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

Returns union: either Boolean or IResolvable

See Also:

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

getDelayInSeconds

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getMessageGroups

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

1 - 5 message groups that contain start messages.

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBotPropsMixin.MessageGroupProperty>

See Also:

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

builder

@Stability(Stable)
static CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty.Builder builder()

Returns:

a CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty.Builder of CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty