software.amazon.awscdk.services.lex

Interface CfnBot.SlotProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.SlotProperty.Jsii$Proxy

Enclosing class:

CfnBot

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

Specifies the definition of a slot.

Amazon Lex elicits slot values from uses to fulfill the user's 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.*;
 SlotProperty slotProperty = SlotProperty.builder()
         .name("name")
         .slotTypeName("slotTypeName")
         .valueElicitationSetting(SlotValueElicitationSettingProperty.builder()
                 .slotConstraint("slotConstraint")
                 // the properties below are optional
                 .defaultValueSpecification(SlotDefaultValueSpecificationProperty.builder()
                         .defaultValueList(List.of(SlotDefaultValueProperty.builder()
                                 .defaultValue("defaultValue")
                                 .build()))
                         .build())
                 .promptSpecification(PromptSpecificationProperty.builder()
                         .maxRetries(123)
                         .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)
                         .messageSelectionStrategy("messageSelectionStrategy")
                         .build())
                 .sampleUtterances(List.of(SampleUtteranceProperty.builder()
                         .utterance("utterance")
                         .build()))
                 .waitAndContinueSpecification(WaitAndContinueSpecificationProperty.builder()
                         .continueResponse(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())
                         .waitingResponse(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())
                         // the properties below are optional
                         .isActive(false)
                         .stillWaitingResponse(StillWaitingResponseSpecificationProperty.builder()
                                 .frequencyInSeconds(123)
                                 .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()))
                                 .timeoutInSeconds(123)
                                 // the properties below are optional
                                 .allowInterrupt(false)
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .multipleValuesSetting(MultipleValuesSettingProperty.builder()
                 .allowMultipleValues(false)
                 .build())
         .obfuscationSetting(ObfuscationSettingProperty.builder()
                 .obfuscationSettingType("obfuscationSettingType")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBot.SlotProperty.Builder	builder()
default String	getDescription() A description of the slot type.
default Object	getMultipleValuesSetting() Determines whether the slot can return multiple values to the application.
String	getName() The name of the slot.
default Object	getObfuscationSetting() Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs.
String	getSlotTypeName() The name of the slot type that this slot is based on.
Object	getValueElicitationSetting() Determines the slot resolution strategy that Amazon Lex uses to return slot type values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the slot.

getSlotTypeName

@Stability(value=Stable)
 @NotNull
String getSlotTypeName()

The name of the slot type that this slot is based on.

The slot type defines the acceptable values for the slot.

getValueElicitationSetting

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

Determines the slot resolution strategy that Amazon Lex uses to return slot type values.

The field can be set to one of the following values:

• OriginalValue - Returns the value entered by the user, if the user value is similar to a slot value.
• TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

If you don't specify the valueSelectionStrategy, the default is OriginalValue.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the slot type.

getMultipleValuesSetting

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

Determines whether the slot can return multiple values to the application.

getObfuscationSetting

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

Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs.

Use obfuscated slots to protect information such as personally identifiable information (PII) in logs.

builder

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

Returns:

a CfnBot.SlotProperty.Builder of CfnBot.SlotProperty