interface FulfillmentStartResponseSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.Lex.CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awslex#CfnBotPropsMixin_FulfillmentStartResponseSpecificationProperty`
Java	`software.amazon.awscdk.cfnpropertymixins.services.lex.CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty`
Python	`aws_cdk.cfn_property_mixins.aws_lex.CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_lex` » `CfnBotPropsMixin` » `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 { aws_lex as lex } from '@aws-cdk/cfn-property-mixins';
const fulfillmentStartResponseSpecificationProperty: lex.CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty = {
  allowInterrupt: false,
  delayInSeconds: 123,
  messageGroups: [{
    message: {
      customPayload: {
        value: 'value',
      },
      imageResponseCard: {
        buttons: [{
          text: 'text',
          value: 'value',
        }],
        imageUrl: 'imageUrl',
        subtitle: 'subtitle',
        title: 'title',
      },
      plainTextMessage: {
        value: 'value',
      },
      ssmlMessage: {
        value: 'value',
      },
    },
    variations: [{
      customPayload: {
        value: 'value',
      },
      imageResponseCard: {
        buttons: [{
          text: 'text',
          value: 'value',
        }],
        imageUrl: 'imageUrl',
        subtitle: 'subtitle',
        title: 'title',
      },
      plainTextMessage: {
        value: 'value',
      },
      ssmlMessage: {
        value: 'value',
      },
    }],
  }],
};

Properties

Name	Type	Description
allowInterrupt?	`boolean \|` `IResolvable`	Determines whether the user can interrupt the start message while it is playing.
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?

Type: boolean | IResolvable (optional)

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

delayInSeconds?

Type: number (optional)

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)[] (optional)

1 - 5 message groups that contain start messages.

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

AWS CDK