1. Packages
  2. AWS Native
  3. API Docs
  4. lex
  5. BotAlias

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.lex.BotAlias

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const botAliasResource = new aws_native.lex.BotAlias("botAliasResource", {
        botId: "string",
        botAliasLocaleSettings: [{
            botAliasLocaleSetting: {
                enabled: false,
                codeHookSpecification: {
                    lambdaCodeHook: {
                        codeHookInterfaceVersion: "string",
                        lambdaArn: "string",
                    },
                },
            },
            localeId: "string",
        }],
        botAliasName: "string",
        botAliasTags: [{
            key: "string",
            value: "string",
        }],
        botVersion: "string",
        conversationLogSettings: {
            audioLogSettings: [{
                destination: {
                    s3Bucket: {
                        logPrefix: "string",
                        s3BucketArn: "string",
                        kmsKeyArn: "string",
                    },
                },
                enabled: false,
            }],
            textLogSettings: [{
                destination: {
                    cloudWatch: {
                        cloudWatchLogGroupArn: "string",
                        logPrefix: "string",
                    },
                },
                enabled: false,
            }],
        },
        description: "string",
        sentimentAnalysisSettings: {
            detectSentiment: false,
        },
    });
    
    Coming soon!
    

    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

    The BotAlias resource accepts the following input properties:

    BotId string
    BotAliasLocaleSettings []BotAliasLocaleSettingsItemArgs
    BotAliasName string
    BotAliasTags []BotAliasTagArgs
    A list of tags to add to the bot alias.
    BotVersion string
    ConversationLogSettings BotAliasConversationLogSettingsArgs
    Description string
    SentimentAnalysisSettings SentimentAnalysisSettingsPropertiesArgs
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    botId String
    botAliasLocaleSettings List<BotAliasLocaleSettingsItem>
    botAliasName String
    botAliasTags List<BotAliasTag>
    A list of tags to add to the bot alias.
    botVersion String
    conversationLogSettings BotAliasConversationLogSettings
    description String
    sentimentAnalysisSettings SentimentAnalysisSettingsProperties
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    botId string
    botAliasLocaleSettings BotAliasLocaleSettingsItem[]
    botAliasName string
    botAliasTags BotAliasTag[]
    A list of tags to add to the bot alias.
    botVersion string
    conversationLogSettings BotAliasConversationLogSettings
    description string
    sentimentAnalysisSettings SentimentAnalysisSettingsProperties
    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    botId String
    botAliasLocaleSettings List<Property Map>
    botAliasName String
    botAliasTags List<Property Map>
    A list of tags to add to the bot alias.
    botVersion String
    conversationLogSettings Property Map
    description String
    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
    BotAliasId string
    BotAliasStatus Pulumi.AwsNative.Lex.BotAliasStatus
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    BotAliasId string
    BotAliasStatus BotAliasStatus
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    botAliasId String
    botAliasStatus BotAliasStatus
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    botAliasId string
    botAliasStatus BotAliasStatus
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    bot_alias_id str
    bot_alias_status BotAliasStatus
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    botAliasId String
    botAliasStatus "Creating" | "Available" | "Deleting" | "Failed"
    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

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi