Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lex
  5. BotAlias

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lex.BotAlias

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    A Bot Alias enables you to change the version of a bot without updating applications that use the bot

    Create BotAlias Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BotAlias(name: string, args: BotAliasArgs, opts?: CustomResourceOptions);
    @overload
def BotAlias(resource_name: str,
             args: BotAliasArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def BotAlias(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             bot_id: Optional[str] = None,
             bot_alias_locale_settings: Optional[Sequence[BotAliasLocaleSettingsItemArgs]] = None,
             bot_alias_name: Optional[str] = None,
             bot_alias_tags: Optional[Sequence[BotAliasTagArgs]] = None,
             bot_version: Optional[str] = None,
             conversation_log_settings: Optional[BotAliasConversationLogSettingsArgs] = None,
             description: Optional[str] = None,
             sentiment_analysis_settings: Optional[SentimentAnalysisSettingsPropertiesArgs] = None)
    func NewBotAlias(ctx *Context, name string, args BotAliasArgs, opts ...ResourceOption) (*BotAlias, error)
    public BotAlias(string name, BotAliasArgs args, CustomResourceOptions? opts = null)
    public BotAlias(String name, BotAliasArgs args)
public BotAlias(String name, BotAliasArgs args, CustomResourceOptions options)

    type: aws-native:lex:BotAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BotAliasArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    BotAlias Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BotAlias resource accepts the following input properties:

    BotId string
    The unique identifier of the bot.
    BotAliasLocaleSettings List<Pulumi.AwsNative.Lex.Inputs.BotAliasLocaleSettingsItem>
    Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
    BotAliasName string
    The name of the bot alias.
    BotAliasTags List<Pulumi.AwsNative.Lex.Inputs.BotAliasTag>
    A list of tags to add to the bot alias.
    BotVersion string
    The version of the bot that the bot alias references.
    ConversationLogSettings Pulumi.AwsNative.Lex.Inputs.BotAliasConversationLogSettings
    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 Pulumi.AwsNative.Lex.Inputs.SentimentAnalysisSettingsProperties
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    BotId string
    The unique identifier of the bot.
    BotAliasLocaleSettings []BotAliasLocaleSettingsItemArgs
    Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
    BotAliasName string
    The name of the bot alias.
    BotAliasTags []BotAliasTagArgs
    A list of tags to add to the bot alias.
    BotVersion string
    The version of the bot that the bot alias references.
    ConversationLogSettings BotAliasConversationLogSettingsArgs
    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 SentimentAnalysisSettingsPropertiesArgs
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    botId String
    The unique identifier of the bot.
    botAliasLocaleSettings List<BotAliasLocaleSettingsItem>
    Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
    botAliasName String
    The name of the bot alias.
    botAliasTags List<BotAliasTag>
    A list of tags to add to the bot alias.
    botVersion String
    The version of the bot that the bot alias references.
    conversationLogSettings BotAliasConversationLogSettings
    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 SentimentAnalysisSettingsProperties
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    botId string
    The unique identifier of the bot.
    botAliasLocaleSettings BotAliasLocaleSettingsItem[]
    Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
    botAliasName string
    The name of the bot alias.
    botAliasTags BotAliasTag[]
    A list of tags to add to the bot alias.
    botVersion string
    The version of the bot that the bot alias references.
    conversationLogSettings BotAliasConversationLogSettings
    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 SentimentAnalysisSettingsProperties
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    bot_id str
    The unique identifier of the bot.
    bot_alias_locale_settings Sequence[BotAliasLocaleSettingsItemArgs]
    Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
    bot_alias_name str
    The name of the bot alias.
    bot_alias_tags Sequence[BotAliasTagArgs]
    A list of tags to add to the bot alias.
    bot_version str
    The version of the bot that the bot alias references.
    conversation_log_settings BotAliasConversationLogSettingsArgs
    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 str
    The description of the bot alias.
    sentiment_analysis_settings SentimentAnalysisSettingsPropertiesArgs
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    botId String
    The unique identifier of the bot.
    botAliasLocaleSettings List<Property Map>
    Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
    botAliasName String
    The name of the bot alias.
    botAliasTags List<Property Map>
    A list of tags to add to the bot alias.
    botVersion String
    The version of the bot that the bot alias references.
    conversationLogSettings Property Map
    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 Property Map
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BotAlias resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the bot alias.
    BotAliasId string
    The unique identifier of the bot alias.
    BotAliasStatus Pulumi.AwsNative.Lex.BotAliasStatus
    The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the bot alias.
    BotAliasId string
    The unique identifier of the bot alias.
    BotAliasStatus BotAliasStatus
    The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the bot alias.
    botAliasId String
    The unique identifier of the bot alias.
    botAliasStatus BotAliasStatus
    The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the bot alias.
    botAliasId string
    The unique identifier of the bot alias.
    botAliasStatus BotAliasStatus
    The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the bot alias.
    bot_alias_id str
    The unique identifier of the bot alias.
    bot_alias_status BotAliasStatus
    The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the bot alias.
    botAliasId String
    The unique identifier of the bot alias.
    botAliasStatus "Creating" | "Available" | "Deleting" | "Failed"
    The current status of the bot alias. When the status is Available the alias is ready for use with your bot.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    BotAliasAudioLogDestination, BotAliasAudioLogDestinationArgs

    BotAliasAudioLogSetting, BotAliasAudioLogSettingArgs

    BotAliasCloudWatchLogGroupLogDestination, BotAliasCloudWatchLogGroupLogDestinationArgs

    CloudWatchLogGroupArn string
    A string used to identify the groupArn for the Cloudwatch Log Group
    LogPrefix string
    A string containing the value for the Log Prefix
    CloudWatchLogGroupArn string
    A string used to identify the groupArn for the Cloudwatch Log Group
    LogPrefix string
    A string containing the value for the Log Prefix
    cloudWatchLogGroupArn String
    A string used to identify the groupArn for the Cloudwatch Log Group
    logPrefix String
    A string containing the value for the Log Prefix
    cloudWatchLogGroupArn string
    A string used to identify the groupArn for the Cloudwatch Log Group
    logPrefix string
    A string containing the value for the Log Prefix
    cloud_watch_log_group_arn str
    A string used to identify the groupArn for the Cloudwatch Log Group
    log_prefix str
    A string containing the value for the Log Prefix
    cloudWatchLogGroupArn String
    A string used to identify the groupArn for the Cloudwatch Log Group
    logPrefix String
    A string containing the value for the Log Prefix

    BotAliasCodeHookSpecification, BotAliasCodeHookSpecificationArgs

    BotAliasConversationLogSettings, BotAliasConversationLogSettingsArgs

    AudioLogSettings List<Pulumi.AwsNative.Lex.Inputs.BotAliasAudioLogSetting>
    The Amazon S3 settings for logging audio to an S3 bucket.
    TextLogSettings List<Pulumi.AwsNative.Lex.Inputs.BotAliasTextLogSetting>
    The Amazon CloudWatch Logs settings for logging text and metadata.
    AudioLogSettings []BotAliasAudioLogSetting
    The Amazon S3 settings for logging audio to an S3 bucket.
    TextLogSettings []BotAliasTextLogSetting
    The Amazon CloudWatch Logs settings for logging text and metadata.
    audioLogSettings List<BotAliasAudioLogSetting>
    The Amazon S3 settings for logging audio to an S3 bucket.
    textLogSettings List<BotAliasTextLogSetting>
    The Amazon CloudWatch Logs settings for logging text and metadata.
    audioLogSettings BotAliasAudioLogSetting[]
    The Amazon S3 settings for logging audio to an S3 bucket.
    textLogSettings BotAliasTextLogSetting[]
    The Amazon CloudWatch Logs settings for logging text and metadata.
    audio_log_settings Sequence[BotAliasAudioLogSetting]
    The Amazon S3 settings for logging audio to an S3 bucket.
    text_log_settings Sequence[BotAliasTextLogSetting]
    The Amazon CloudWatch Logs settings for logging text and metadata.
    audioLogSettings List<Property Map>
    The Amazon S3 settings for logging audio to an S3 bucket.
    textLogSettings List<Property Map>
    The Amazon CloudWatch Logs settings for logging text and metadata.

    BotAliasLambdaCodeHook, BotAliasLambdaCodeHookArgs

    CodeHookInterfaceVersion string
    The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
    LambdaArn string
    The Amazon Resource Name (ARN) of the Lambda function.
    CodeHookInterfaceVersion string
    The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
    LambdaArn string
    The Amazon Resource Name (ARN) of the Lambda function.
    codeHookInterfaceVersion String
    The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
    lambdaArn String
    The Amazon Resource Name (ARN) of the Lambda function.
    codeHookInterfaceVersion string
    The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
    lambdaArn string
    The Amazon Resource Name (ARN) of the Lambda function.
    code_hook_interface_version str
    The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
    lambda_arn str
    The Amazon Resource Name (ARN) of the Lambda function.
    codeHookInterfaceVersion String
    The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
    lambdaArn String
    The Amazon Resource Name (ARN) of the Lambda function.

    BotAliasLocaleSettings, BotAliasLocaleSettingsArgs

    Enabled bool
    Whether the Lambda code hook is enabled
    CodeHookSpecification BotAliasCodeHookSpecification
    enabled Boolean
    Whether the Lambda code hook is enabled
    codeHookSpecification BotAliasCodeHookSpecification
    enabled boolean
    Whether the Lambda code hook is enabled
    codeHookSpecification BotAliasCodeHookSpecification
    enabled bool
    Whether the Lambda code hook is enabled
    code_hook_specification BotAliasCodeHookSpecification
    enabled Boolean
    Whether the Lambda code hook is enabled
    codeHookSpecification Property Map

    BotAliasLocaleSettingsItem, BotAliasLocaleSettingsItemArgs

    BotAliasLocaleSetting BotAliasLocaleSettings
    LocaleId string
    A string used to identify the locale
    botAliasLocaleSetting BotAliasLocaleSettings
    localeId String
    A string used to identify the locale
    botAliasLocaleSetting BotAliasLocaleSettings
    localeId string
    A string used to identify the locale
    bot_alias_locale_setting BotAliasLocaleSettings
    locale_id str
    A string used to identify the locale
    botAliasLocaleSetting Property Map
    localeId String
    A string used to identify the locale

    BotAliasS3BucketLogDestination, BotAliasS3BucketLogDestinationArgs

    LogPrefix string
    The Amazon S3 key of the deployment package.
    S3BucketArn string
    The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
    KmsKeyArn string
    The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
    LogPrefix string
    The Amazon S3 key of the deployment package.
    S3BucketArn string
    The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
    KmsKeyArn string
    The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
    logPrefix String
    The Amazon S3 key of the deployment package.
    s3BucketArn String
    The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
    kmsKeyArn String
    The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
    logPrefix string
    The Amazon S3 key of the deployment package.
    s3BucketArn string
    The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
    kmsKeyArn string
    The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
    log_prefix str
    The Amazon S3 key of the deployment package.
    s3_bucket_arn str
    The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
    kms_key_arn str
    The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
    logPrefix String
    The Amazon S3 key of the deployment package.
    s3BucketArn String
    The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
    kmsKeyArn String
    The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

    BotAliasStatus, BotAliasStatusArgs

    Creating
    Creating
    Available
    Available
    Deleting
    Deleting
    Failed
    Failed
    BotAliasStatusCreating
    Creating
    BotAliasStatusAvailable
    Available
    BotAliasStatusDeleting
    Deleting
    BotAliasStatusFailed
    Failed
    Creating
    Creating
    Available
    Available
    Deleting
    Deleting
    Failed
    Failed
    Creating
    Creating
    Available
    Available
    Deleting
    Deleting
    Failed
    Failed
    CREATING
    Creating
    AVAILABLE
    Available
    DELETING
    Deleting
    FAILED
    Failed
    "Creating"
    Creating
    "Available"
    Available
    "Deleting"
    Deleting
    "Failed"
    Failed

    BotAliasTag, BotAliasTagArgs

    Key string
    A string used to identify this tag
    Value string
    A string containing the value for the tag
    Key string
    A string used to identify this tag
    Value string
    A string containing the value for the tag
    key String
    A string used to identify this tag
    value String
    A string containing the value for the tag
    key string
    A string used to identify this tag
    value string
    A string containing the value for the tag
    key str
    A string used to identify this tag
    value str
    A string containing the value for the tag
    key String
    A string used to identify this tag
    value String
    A string containing the value for the tag

    BotAliasTextLogDestination, BotAliasTextLogDestinationArgs

    BotAliasTextLogSetting, BotAliasTextLogSettingArgs

    SentimentAnalysisSettingsProperties, SentimentAnalysisSettingsPropertiesArgs

    DetectSentiment bool
    Enable to call Amazon Comprehend for Sentiment natively within Lex
    DetectSentiment bool
    Enable to call Amazon Comprehend for Sentiment natively within Lex
    detectSentiment Boolean
    Enable to call Amazon Comprehend for Sentiment natively within Lex
    detectSentiment boolean
    Enable to call Amazon Comprehend for Sentiment natively within Lex
    detect_sentiment bool
    Enable to call Amazon Comprehend for Sentiment natively within Lex
    detectSentiment Boolean
    Enable to call Amazon Comprehend for Sentiment natively within Lex

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native