ConditionalSpecificationProperty Struct
Provides a list of conditional branches.
Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
declare const slotValueOverrideProperty_: lex.CfnBot.SlotValueOverrideProperty;
const conditionalSpecificationProperty: lex.CfnBot.ConditionalSpecificationProperty = {
conditionalBranches: [{
condition: {
expressionString: 'expressionString',
},
name: 'name',
nextStep: {
dialogAction: {
type: 'type',
// the properties below are optional
slotToElicit: 'slotToElicit',
suppressNextMessage: false,
},
intent: {
name: 'name',
slots: [{
slotName: 'slotName',
slotValueOverride: {
shape: 'shape',
value: {
interpretedValue: 'interpretedValue',
},
values: [slotValueOverrideProperty_],
},
}],
},
sessionAttributes: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
},
// the properties below are optional
response: {
messageGroupsList: [{
message: {
customPayload: {
value: 'value',
},
imageResponseCard: {
title: 'title',
// the properties below are optional
buttons: [{
text: 'text',
value: 'value',
}],
imageUrl: 'imageUrl',
subtitle: 'subtitle',
},
plainTextMessage: {
value: 'value',
},
ssmlMessage: {
value: 'value',
},
},
// the properties below are optional
variations: [{
customPayload: {
value: 'value',
},
imageResponseCard: {
title: 'title',
// the properties below are optional
buttons: [{
text: 'text',
value: 'value',
}],
imageUrl: 'imageUrl',
subtitle: 'subtitle',
},
plainTextMessage: {
value: 'value',
},
ssmlMessage: {
value: 'value',
},
}],
}],
// the properties below are optional
allowInterrupt: false,
},
}],
defaultBranch: {
nextStep: {
dialogAction: {
type: 'type',
// the properties below are optional
slotToElicit: 'slotToElicit',
suppressNextMessage: false,
},
intent: {
name: 'name',
slots: [{
slotName: 'slotName',
slotValueOverride: {
shape: 'shape',
value: {
interpretedValue: 'interpretedValue',
},
values: [slotValueOverrideProperty_],
},
}],
},
sessionAttributes: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
},
response: {
messageGroupsList: [{
message: {
customPayload: {
value: 'value',
},
imageResponseCard: {
title: 'title',
// the properties below are optional
buttons: [{
text: 'text',
value: 'value',
}],
imageUrl: 'imageUrl',
subtitle: 'subtitle',
},
plainTextMessage: {
value: 'value',
},
ssmlMessage: {
value: 'value',
},
},
// the properties below are optional
variations: [{
customPayload: {
value: 'value',
},
imageResponseCard: {
title: 'title',
// the properties below are optional
buttons: [{
text: 'text',
value: 'value',
}],
imageUrl: 'imageUrl',
subtitle: 'subtitle',
},
plainTextMessage: {
value: 'value',
},
ssmlMessage: {
value: 'value',
},
}],
}],
// the properties below are optional
allowInterrupt: false,
},
},
isActive: false,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lex as lex
# slot_value_override_property_: lex.CfnBot.SlotValueOverrideProperty
conditional_specification_property = lex.CfnBot.ConditionalSpecificationProperty(
conditional_branches=[lex.CfnBot.ConditionalBranchProperty(
condition=lex.CfnBot.ConditionProperty(
expression_string="expressionString"
),
name="name",
next_step=lex.CfnBot.DialogStateProperty(
dialog_action=lex.CfnBot.DialogActionProperty(
type="type",
# the properties below are optional
slot_to_elicit="slotToElicit",
suppress_next_message=False
),
intent=lex.CfnBot.IntentOverrideProperty(
name="name",
slots=[lex.CfnBot.SlotValueOverrideMapProperty(
slot_name="slotName",
slot_value_override=lex.CfnBot.SlotValueOverrideProperty(
shape="shape",
value=lex.CfnBot.SlotValueProperty(
interpreted_value="interpretedValue"
),
values=[slot_value_override_property_]
)
)]
),
session_attributes=[lex.CfnBot.SessionAttributeProperty(
key="key",
# the properties below are optional
value="value"
)]
),
# the properties below are optional
response=lex.CfnBot.ResponseSpecificationProperty(
message_groups_list=[lex.CfnBot.MessageGroupProperty(
message=lex.CfnBot.MessageProperty(
custom_payload=lex.CfnBot.CustomPayloadProperty(
value="value"
),
image_response_card=lex.CfnBot.ImageResponseCardProperty(
title="title",
# the properties below are optional
buttons=[lex.CfnBot.ButtonProperty(
text="text",
value="value"
)],
image_url="imageUrl",
subtitle="subtitle"
),
plain_text_message=lex.CfnBot.PlainTextMessageProperty(
value="value"
),
ssml_message=lex.CfnBot.SSMLMessageProperty(
value="value"
)
),
# the properties below are optional
variations=[lex.CfnBot.MessageProperty(
custom_payload=lex.CfnBot.CustomPayloadProperty(
value="value"
),
image_response_card=lex.CfnBot.ImageResponseCardProperty(
title="title",
# the properties below are optional
buttons=[lex.CfnBot.ButtonProperty(
text="text",
value="value"
)],
image_url="imageUrl",
subtitle="subtitle"
),
plain_text_message=lex.CfnBot.PlainTextMessageProperty(
value="value"
),
ssml_message=lex.CfnBot.SSMLMessageProperty(
value="value"
)
)]
)],
# the properties below are optional
allow_interrupt=False
)
)],
default_branch=lex.CfnBot.DefaultConditionalBranchProperty(
next_step=lex.CfnBot.DialogStateProperty(
dialog_action=lex.CfnBot.DialogActionProperty(
type="type",
# the properties below are optional
slot_to_elicit="slotToElicit",
suppress_next_message=False
),
intent=lex.CfnBot.IntentOverrideProperty(
name="name",
slots=[lex.CfnBot.SlotValueOverrideMapProperty(
slot_name="slotName",
slot_value_override=lex.CfnBot.SlotValueOverrideProperty(
shape="shape",
value=lex.CfnBot.SlotValueProperty(
interpreted_value="interpretedValue"
),
values=[slot_value_override_property_]
)
)]
),
session_attributes=[lex.CfnBot.SessionAttributeProperty(
key="key",
# the properties below are optional
value="value"
)]
),
response=lex.CfnBot.ResponseSpecificationProperty(
message_groups_list=[lex.CfnBot.MessageGroupProperty(
message=lex.CfnBot.MessageProperty(
custom_payload=lex.CfnBot.CustomPayloadProperty(
value="value"
),
image_response_card=lex.CfnBot.ImageResponseCardProperty(
title="title",
# the properties below are optional
buttons=[lex.CfnBot.ButtonProperty(
text="text",
value="value"
)],
image_url="imageUrl",
subtitle="subtitle"
),
plain_text_message=lex.CfnBot.PlainTextMessageProperty(
value="value"
),
ssml_message=lex.CfnBot.SSMLMessageProperty(
value="value"
)
),
# the properties below are optional
variations=[lex.CfnBot.MessageProperty(
custom_payload=lex.CfnBot.CustomPayloadProperty(
value="value"
),
image_response_card=lex.CfnBot.ImageResponseCardProperty(
title="title",
# the properties below are optional
buttons=[lex.CfnBot.ButtonProperty(
text="text",
value="value"
)],
image_url="imageUrl",
subtitle="subtitle"
),
plain_text_message=lex.CfnBot.PlainTextMessageProperty(
value="value"
),
ssml_message=lex.CfnBot.SSMLMessageProperty(
value="value"
)
)]
)],
# the properties below are optional
allow_interrupt=False
)
),
is_active=False
)
java
// 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.*;
SlotValueOverrideProperty slotValueOverrideProperty_;
ConditionalSpecificationProperty conditionalSpecificationProperty = ConditionalSpecificationProperty.builder()
.conditionalBranches(List.of(ConditionalBranchProperty.builder()
.condition(ConditionProperty.builder()
.expressionString("expressionString")
.build())
.name("name")
.nextStep(DialogStateProperty.builder()
.dialogAction(DialogActionProperty.builder()
.type("type")
// the properties below are optional
.slotToElicit("slotToElicit")
.suppressNextMessage(false)
.build())
.intent(IntentOverrideProperty.builder()
.name("name")
.slots(List.of(SlotValueOverrideMapProperty.builder()
.slotName("slotName")
.slotValueOverride(SlotValueOverrideProperty.builder()
.shape("shape")
.value(SlotValueProperty.builder()
.interpretedValue("interpretedValue")
.build())
.values(List.of(slotValueOverrideProperty_))
.build())
.build()))
.build())
.sessionAttributes(List.of(SessionAttributeProperty.builder()
.key("key")
// the properties below are optional
.value("value")
.build()))
.build())
// the properties below are optional
.response(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()))
.defaultBranch(DefaultConditionalBranchProperty.builder()
.nextStep(DialogStateProperty.builder()
.dialogAction(DialogActionProperty.builder()
.type("type")
// the properties below are optional
.slotToElicit("slotToElicit")
.suppressNextMessage(false)
.build())
.intent(IntentOverrideProperty.builder()
.name("name")
.slots(List.of(SlotValueOverrideMapProperty.builder()
.slotName("slotName")
.slotValueOverride(SlotValueOverrideProperty.builder()
.shape("shape")
.value(SlotValueProperty.builder()
.interpretedValue("interpretedValue")
.build())
.values(List.of(slotValueOverrideProperty_))
.build())
.build()))
.build())
.sessionAttributes(List.of(SessionAttributeProperty.builder()
.key("key")
// the properties below are optional
.value("value")
.build()))
.build())
.response(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())
.isActive(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lex;
SlotValueOverrideProperty slotValueOverrideProperty_;
var conditionalSpecificationProperty = new ConditionalSpecificationProperty {
ConditionalBranches = new [] { new ConditionalBranchProperty {
Condition = new ConditionProperty {
ExpressionString = "expressionString"
},
Name = "name",
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
// the properties below are optional
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
} },
DefaultBranch = new DefaultConditionalBranchProperty {
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
},
IsActive = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var slotValueOverrideProperty_ SlotValueOverrideProperty
conditionalSpecificationProperty := &ConditionalSpecificationProperty{
ConditionalBranches: []interface{}{
&ConditionalBranchProperty{
Condition: &ConditionProperty{
ExpressionString: jsii.String("expressionString"),
},
Name: jsii.String("name"),
NextStep: &DialogStateProperty{
DialogAction: &DialogActionProperty{
Type: jsii.String("type"),
// the properties below are optional
SlotToElicit: jsii.String("slotToElicit"),
SuppressNextMessage: jsii.Boolean(false),
},
Intent: &IntentOverrideProperty{
Name: jsii.String("name"),
Slots: []interface{}{
&SlotValueOverrideMapProperty{
SlotName: jsii.String("slotName"),
SlotValueOverride: &SlotValueOverrideProperty{
Shape: jsii.String("shape"),
Value: &SlotValueProperty{
InterpretedValue: jsii.String("interpretedValue"),
},
Values: []interface{}{
slotValueOverrideProperty_,
},
},
},
},
},
SessionAttributes: []interface{}{
&SessionAttributeProperty{
Key: jsii.String("key"),
// the properties below are optional
Value: jsii.String("value"),
},
},
},
// the properties below are optional
Response: &ResponseSpecificationProperty{
MessageGroupsList: []interface{}{
&MessageGroupProperty{
Message: &MessageProperty{
CustomPayload: &CustomPayloadProperty{
Value: jsii.String("value"),
},
ImageResponseCard: &ImageResponseCardProperty{
Title: jsii.String("title"),
// the properties below are optional
Buttons: []interface{}{
&ButtonProperty{
Text: jsii.String("text"),
Value: jsii.String("value"),
},
},
ImageUrl: jsii.String("imageUrl"),
Subtitle: jsii.String("subtitle"),
},
PlainTextMessage: &PlainTextMessageProperty{
Value: jsii.String("value"),
},
SsmlMessage: &SSMLMessageProperty{
Value: jsii.String("value"),
},
},
// the properties below are optional
Variations: []interface{}{
&MessageProperty{
CustomPayload: &CustomPayloadProperty{
Value: jsii.String("value"),
},
ImageResponseCard: &ImageResponseCardProperty{
Title: jsii.String("title"),
// the properties below are optional
Buttons: []interface{}{
&ButtonProperty{
Text: jsii.String("text"),
Value: jsii.String("value"),
},
},
ImageUrl: jsii.String("imageUrl"),
Subtitle: jsii.String("subtitle"),
},
PlainTextMessage: &PlainTextMessageProperty{
Value: jsii.String("value"),
},
SsmlMessage: &SSMLMessageProperty{
Value: jsii.String("value"),
},
},
},
},
},
// the properties below are optional
AllowInterrupt: jsii.Boolean(false),
},
},
},
DefaultBranch: &DefaultConditionalBranchProperty{
NextStep: &DialogStateProperty{
DialogAction: &DialogActionProperty{
Type: jsii.String("type"),
// the properties below are optional
SlotToElicit: jsii.String("slotToElicit"),
SuppressNextMessage: jsii.Boolean(false),
},
Intent: &IntentOverrideProperty{
Name: jsii.String("name"),
Slots: []interface{}{
&SlotValueOverrideMapProperty{
SlotName: jsii.String("slotName"),
SlotValueOverride: &SlotValueOverrideProperty{
Shape: jsii.String("shape"),
Value: &SlotValueProperty{
InterpretedValue: jsii.String("interpretedValue"),
},
Values: []interface{}{
slotValueOverrideProperty_,
},
},
},
},
},
SessionAttributes: []interface{}{
&SessionAttributeProperty{
Key: jsii.String("key"),
// the properties below are optional
Value: jsii.String("value"),
},
},
},
Response: &ResponseSpecificationProperty{
MessageGroupsList: []interface{}{
&MessageGroupProperty{
Message: &MessageProperty{
CustomPayload: &CustomPayloadProperty{
Value: jsii.String("value"),
},
ImageResponseCard: &ImageResponseCardProperty{
Title: jsii.String("title"),
// the properties below are optional
Buttons: []interface{}{
&ButtonProperty{
Text: jsii.String("text"),
Value: jsii.String("value"),
},
},
ImageUrl: jsii.String("imageUrl"),
Subtitle: jsii.String("subtitle"),
},
PlainTextMessage: &PlainTextMessageProperty{
Value: jsii.String("value"),
},
SsmlMessage: &SSMLMessageProperty{
Value: jsii.String("value"),
},
},
// the properties below are optional
Variations: []interface{}{
&MessageProperty{
CustomPayload: &CustomPayloadProperty{
Value: jsii.String("value"),
},
ImageResponseCard: &ImageResponseCardProperty{
Title: jsii.String("title"),
// the properties below are optional
Buttons: []interface{}{
&ButtonProperty{
Text: jsii.String("text"),
Value: jsii.String("value"),
},
},
ImageUrl: jsii.String("imageUrl"),
Subtitle: jsii.String("subtitle"),
},
PlainTextMessage: &PlainTextMessageProperty{
Value: jsii.String("value"),
},
SsmlMessage: &SSMLMessageProperty{
Value: jsii.String("value"),
},
},
},
},
},
// the properties below are optional
AllowInterrupt: jsii.Boolean(false),
},
},
IsActive: jsii.Boolean(false),
}
Properties
conditionalBranchesIResolvable | IResolvable | CfnBot.ConditionalBranchProperty[]conditional_branchestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ConditionalBranchProperty]]]conditionalBranchesIResolvableConditionalBranchesIResolvableConditionalBranchesinterface{}required#A list of conditional branches.
A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
defaultBranchIResolvable | CfnBot.DefaultConditionalBranchPropertydefault_branchtyping.Union[IResolvable, DefaultConditionalBranchProperty]defaultBranchIResolvableDefaultBranchIResolvableDefaultBranchinterface{}required#The conditional branch that should be followed when the conditions for other branches are not satisfied.
A conditional branch is made up of a condition, a response and a next step.
isActiveboolean | IResolvableis_activetyping.Union[bool, IResolvable]isActiveBooleanIsActiveboolIsActiveinterface{}required#Determines whether a conditional branch is active.
When IsActive is false, the conditions are not evaluated.