AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Lex::BotAlias

CfnBotAlias

> Amazon Lex V2 is the only supported version in CloudFormation . Specifies an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot. For example, you can specify an alias called "PROD" that your applications use to call the Amazon Lex bot.

Import

import { CfnBotAlias } from 'aws-cdk-lib/aws-lex';

Or use the module namespace:

import * as lex from 'aws-cdk-lib/aws-lex';
// lex.CfnBotAlias

Properties

Configuration passed to the constructor as CfnBotAliasProps.

botAliasNameRequired
string

The name of the bot alias.

botIdRequired
string

The unique identifier of the bot.

botAliasLocaleSettingsOptional
IResolvable | IResolvable | BotAliasLocaleSettingsItemProperty[]

Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.

botAliasTagsOptional
CfnTag[]

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) .

botVersionOptional
string

The version of the bot that the bot alias references.

conversationLogSettingsOptional
IResolvable | ConversationLogSettingsProperty

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 .

descriptionOptional
string

The description of the bot alias.

sentimentAnalysisSettingsOptional
any

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Lex::BotAliasView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-lex
CFN TypeAWS::Lex::BotAlias
Properties8

Related Constructs

Explore This Service

External Links