interface FulfillmentStartResponseSpecificationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Lex.CfnBot.FulfillmentStartResponseSpecificationProperty
Java	software.amazon.awscdk.services.lex.CfnBot.FulfillmentStartResponseSpecificationProperty
Python	aws_cdk.aws_lex.CfnBot.FulfillmentStartResponseSpecificationProperty
TypeScript	@aws-cdk/aws-lex » CfnBot » FulfillmentStartResponseSpecificationProperty

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 * as lex from '@aws-cdk/aws-lex';
const fulfillmentStartResponseSpecificationProperty: lex.CfnBot.FulfillmentStartResponseSpecificationProperty = {
  delayInSeconds: 123,
  messageGroups: [{
    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

Name	Type	Description
delayInSeconds	number	The delay between when the Lambda fulfillment function starts running and the start message is played.
messageGroups	IResolvable | IResolvable | MessageGroupProperty[]	1 - 5 message groups that contain start messages.
allowInterrupt?	boolean | IResolvable	Determines whether the user can interrupt the start message while it is playing.

---

delayInSeconds

Type: number

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.

---

messageGroups

Type: IResolvable | IResolvable | MessageGroupProperty[]

1 - 5 message groups that contain start messages.

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

---

allowInterrupt?

Type: boolean | IResolvable (optional)

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