aws-cdk-lib.aws_lex.CfnBot.ConditionalBranchProperty

interface ConditionalBranchProperty

LanguageType name
.NETAmazon.CDK.AWS.Lex.CfnBot.ConditionalBranchProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_ConditionalBranchProperty
Javasoftware.amazon.awscdk.services.lex.CfnBot.ConditionalBranchProperty
Pythonaws_cdk.aws_lex.CfnBot.ConditionalBranchProperty
TypeScript aws-cdk-lib » aws_lex » CfnBot » ConditionalBranchProperty

A set of actions that Amazon Lex should run if the condition is matched.

Example

// 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 conditionalBranchProperty: lex.CfnBot.ConditionalBranchProperty = {
  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,
  },
};

Properties

NameTypeDescription
conditionIResolvable | ConditionPropertyContains the expression to evaluate.
namestringThe name of the branch.
nextStepIResolvable | DialogStatePropertyThe next step in the conversation.
response?IResolvable | ResponseSpecificationPropertySpecifies a list of message groups that Amazon Lex uses to respond the user input.

condition

Type: IResolvable | ConditionProperty

Contains the expression to evaluate.

If the condition is true, the branch's actions are taken.


name

Type: string

The name of the branch.


nextStep

Type: IResolvable | DialogStateProperty

The next step in the conversation.


response?

Type: IResolvable | ResponseSpecificationProperty (optional)

Specifies a list of message groups that Amazon Lex uses to respond the user input.