interface CfnBotAliasProps

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

Properties for defining a CfnBotAlias.

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';

declare const sentimentAnalysisSettings: any;
const cfnBotAliasProps: lex.CfnBotAliasProps = {
  botAliasName: 'botAliasName',
  botId: 'botId',

  // the properties below are optional
  botAliasLocaleSettings: [{
    botAliasLocaleSetting: {
      enabled: false,

      // the properties below are optional
      codeHookSpecification: {
        lambdaCodeHook: {
          codeHookInterfaceVersion: 'codeHookInterfaceVersion',
          lambdaArn: 'lambdaArn',
        },
      },
    },
    localeId: 'localeId',
  }],
  botAliasTags: [{
    key: 'key',
    value: 'value',
  }],
  botVersion: 'botVersion',
  conversationLogSettings: {
    audioLogSettings: [{
      destination: {
        s3Bucket: {
          logPrefix: 'logPrefix',
          s3BucketArn: 's3BucketArn',

          // the properties below are optional
          kmsKeyArn: 'kmsKeyArn',
        },
      },
      enabled: false,
    }],
    textLogSettings: [{
      destination: {
        cloudWatch: {
          cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
          logPrefix: 'logPrefix',
        },
      },
      enabled: false,
    }],
  },
  description: 'description',
  sentimentAnalysisSettings: sentimentAnalysisSettings,
};

Properties

Name	Type	Description
botAliasName	string	The name of the bot alias.
botId	string	The unique identifier of the bot.
botAliasLocaleSettings?	IResolvable | IResolvable | BotAliasLocaleSettingsItemProperty[]	Specifies settings that are unique to a locale.
botAliasTags?	IResolvable | IResolvable | CfnTag[]	An array of key-value pairs to apply to this resource.
botVersion?	string	The version of the bot that the bot alias references.
conversationLogSettings?	IResolvable | ConversationLogSettingsProperty	Specifies whether Amazon Lex logs text and audio for conversations with the bot.
description?	string	The description of the bot alias.
sentimentAnalysisSettings?	any	Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

---

botAliasName

Type: string

The name of the bot alias.

---

botId

Type: string

The unique identifier of the bot.

---

botAliasLocaleSettings?

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

Specifies settings that are unique to a locale.

For example, you can use different Lambda function depending on the bot's locale.

---

botAliasTags?

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

An array of key-value pairs to apply to this resource.

You can only add tags when you specify an alias.

For more information, see Tag .

---

botVersion?

Type: string (optional)

The version of the bot that the bot alias references.

---

conversationLogSettings?

Type: IResolvable | ConversationLogSettingsProperty (optional)

Specifies whether Amazon Lex logs text and audio for conversations with the bot.

When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch logs. Audio logs store input in Amazon S3 .

---

description?

Type: string (optional)

The description of the bot alias.

---

sentimentAnalysisSettings?

Type: any (optional)

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.