interface FulfillmentUpdateResponseSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Lex.Mixins.CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslex/mixins#CfnBotPropsMixin_FulfillmentUpdateResponseSpecificationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.lex.mixins.CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty`
Python	`aws_cdk.mixins_preview.aws_lex.mixins.CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_lex` » `mixins` » `CfnBotPropsMixin` » `FulfillmentUpdateResponseSpecificationProperty`

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as lex_mixins } from '@aws-cdk/mixins-preview/aws-lex';
const fulfillmentUpdateResponseSpecificationProperty: lex_mixins.CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty = {
  allowInterrupt: false,
  frequencyInSeconds: 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 an update message while it is playing.
frequencyInSeconds?	`number`	The frequency that a message is sent to the user.
messageGroups?	`IResolvable` `\| (IResolvable` `\|` `MessageGroupProperty)[]`	1 - 5 message groups that contain update messages.

allowInterrupt?

Type: boolean | IResolvable (optional)

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

frequencyInSeconds?

Type: number (optional)

The frequency that a message is sent to the user.

When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

messageGroups?

Type: IResolvable | (IResolvable | MessageGroupProperty)[] (optional)

1 - 5 message groups that contain update messages.

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

AWS CDK