# CfnBotAliasProps

Properties for defining a `CfnBotAlias`.

Extends: CfnBotAliasProps
Used as props by: CfnBotAlias

- Source: Generated code
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

```ts
// 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 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

- `botAliasLocaleSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnBotAlias.BotAliasLocaleSettingsItemProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_lex.CfnBotAlias.BotAliasLocaleSettingsItemProperty.html)[] — Specifies settings that are unique to a locale.

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

- `botAliasName`: string (required) — The name of the bot alias.

- `botAliasTags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

- `botId`: string (required) — The unique identifier of the bot.

- `botVersion`: string — The version of the bot that the bot alias references.

- `conversationLogSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnBotAlias.ConversationLogSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_lex.CfnBotAlias.ConversationLogSettingsProperty.html) — 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`: string — The description of the bot alias.

- `sentimentAnalysisSettings`: any — Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.