AWS Fundamentals Logo
AWS Fundamentals
AWS::Lex::BotAlias

Lex BotAlias

Resource Type definition for a Bot Alias, which enables you to change the version of a bot without updating applications that use the bot

Properties

8 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
BotAliasName
string
Required
BotId
string
RequiredCreate-only
BotAliasLocaleSettings
array
BotAliasTags
Array<Tag>
BotVersion
string
ConversationLogSettings
ConversationLogSettings
Description
string
SentimentAnalysisSettings
object

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
BotAliasIdstring-
BotAliasStatusstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Lex::BotAlias

Resources:
  MyResource:
    Type: AWS::Lex::BotAlias
    Properties:
      BotId: "my-botid"
      BotAliasName: "my-botaliasname"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

lex:CreateBotAliaslex:DescribeBotlex:DescribeBotAliaslex:TagResourcelex:ListTagsForResource

update

lex:UpdateBotAliaslex:DescribeBotAliaslex:ListTagsForResourcelex:TagResourcelex:UntagResource

read

lex:DescribeBotAliaslex:ListTagsForResource

delete

lex:DeleteBotAlias

list

lex:ListBotAliaseslex:ListTagsForResource

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

ServiceLex
Properties11
Required2
TaggingSupported
Primary IDBotAliasId

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

BotId

Related Resources

External Links