AWS::Lex::BotAlias
Note
Amazon Lex V2 is the only supported version in AWS 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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Lex::BotAlias", "Properties" : { "BotAliasLocaleSettings" :
[ BotAliasLocaleSettingsItem, ... ]
, "BotAliasName" :String
, "BotAliasTags" :[ Tag, ... ]
, "BotId" :String
, "BotVersion" :String
, "ConversationLogSettings" :ConversationLogSettings
, "Description" :String
, "SentimentAnalysisSettings" :SentimentAnalysisSettings
} }
YAML
Type: AWS::Lex::BotAlias Properties: BotAliasLocaleSettings:
- BotAliasLocaleSettingsItem
BotAliasName:String
BotAliasTags:- Tag
BotId:String
BotVersion:String
ConversationLogSettings:ConversationLogSettings
Description:String
SentimentAnalysisSettings:SentimentAnalysisSettings
Properties
BotAliasLocaleSettings
-
Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
Required: No
Type: List of BotAliasLocaleSettingsItem
Update requires: No interruption
BotAliasName
-
The name of the bot alias.
Required: Yes
Type: String
Minimum:
1
Maximum:
100
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$
Update requires: No interruption
BotAliasTags
-
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.
Required: No
Type: List of Tag
Update requires: No interruption
BotId
-
The unique identifier of the bot.
Required: Yes
Type: String
Update requires: Replacement
BotVersion
-
The version of the bot that the bot alias references.
Required: No
Type: String
Minimum:
1
Maximum:
5
Pattern:
^(DRAFT|[0-9]+)$
Update requires: No interruption
ConversationLogSettings
-
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.
Required: No
Type: ConversationLogSettings
Update requires: No interruption
Description
-
The description of the bot alias.
Required: No
Type: String
Minimum:
0
Maximum:
200
Update requires: No interruption
SentimentAnalysisSettings
-
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Required: No
Type: SentimentAnalysisSettings
Update requires: No interruption