Package 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(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:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBot.SlotProperty.Builder	builder()
default String	getDescription()	The description of the slot.
default Object	getMultipleValuesSetting()	Indicates whether a slot can return multiple values.
String	getName()	The name given to 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.
default Object	getSubSlotSetting()	Returns union: either IResolvable or CfnBot.SubSlotSettingProperty
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 Details

getName

@Stability(Stable)
@NotNull
String getName()

The name given to the slot.

See Also:

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

getSlotTypeName

@Stability(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.

See Also:

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

getValueElicitationSetting

@Stability(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:

• ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to a slot value.
• TOP_RESOLUTION - 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 ORIGINAL_VALUE .

Returns union: either IResolvable or CfnBot.SlotValueElicitationSettingProperty

See Also:

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

getDescription

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

The description of the slot.

See Also:

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

getMultipleValuesSetting

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

Indicates whether a slot can return multiple values.

Returns union: either IResolvable or CfnBot.MultipleValuesSettingProperty

See Also:

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

getObfuscationSetting

@Stability(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.

Returns union: either IResolvable or CfnBot.ObfuscationSettingProperty

See Also:

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

getSubSlotSetting

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

Returns union: either IResolvable or CfnBot.SubSlotSettingProperty

See Also:

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

builder

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

Returns:

a CfnBot.SlotProperty.Builder of CfnBot.SlotProperty