CfnBotAliasProps

class aws_cdk.aws_lex.CfnBotAliasProps(*, bot_alias_name, bot_id, bot_alias_locale_settings=None, bot_alias_tags=None, bot_version=None, conversation_log_settings=None, description=None, sentiment_analysis_settings=None)

Bases: object

Properties for defining a CfnBotAlias.

Parameters:

• bot_alias_name (str) – The name of the bot alias.

• bot_id (str) – The unique identifier of the bot.

• bot_alias_locale_settings (Union[IResolvable, Sequence[Union[IResolvable, BotAliasLocaleSettingsItemProperty, Dict[str, Any]]], None]) – Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot’s locale.

• bot_alias_tags (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – 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 .

• bot_version (Optional[str]) – The version of the bot that the bot alias references.

• conversation_log_settings (Union[IResolvable, ConversationLogSettingsProperty, Dict[str, Any], None]) – 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 (Optional[str]) – The description of the bot alias.

• sentiment_analysis_settings (Optional[Any]) – Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lex as lex

# sentiment_analysis_settings: Any

cfn_bot_alias_props = lex.CfnBotAliasProps(
    bot_alias_name="botAliasName",
    bot_id="botId",

    # the properties below are optional
    bot_alias_locale_settings=[lex.CfnBotAlias.BotAliasLocaleSettingsItemProperty(
        bot_alias_locale_setting=lex.CfnBotAlias.BotAliasLocaleSettingsProperty(
            enabled=False,

            # the properties below are optional
            code_hook_specification=lex.CfnBotAlias.CodeHookSpecificationProperty(
                lambda_code_hook=lex.CfnBotAlias.LambdaCodeHookProperty(
                    code_hook_interface_version="codeHookInterfaceVersion",
                    lambda_arn="lambdaArn"
                )
            )
        ),
        locale_id="localeId"
    )],
    bot_alias_tags=[CfnTag(
        key="key",
        value="value"
    )],
    bot_version="botVersion",
    conversation_log_settings=lex.CfnBotAlias.ConversationLogSettingsProperty(
        audio_log_settings=[lex.CfnBotAlias.AudioLogSettingProperty(
            destination=lex.CfnBotAlias.AudioLogDestinationProperty(
                s3_bucket=lex.CfnBotAlias.S3BucketLogDestinationProperty(
                    log_prefix="logPrefix",
                    s3_bucket_arn="s3BucketArn",

                    # the properties below are optional
                    kms_key_arn="kmsKeyArn"
                )
            ),
            enabled=False
        )],
        text_log_settings=[lex.CfnBotAlias.TextLogSettingProperty(
            destination=lex.CfnBotAlias.TextLogDestinationProperty(
                cloud_watch=lex.CfnBotAlias.CloudWatchLogGroupLogDestinationProperty(
                    cloud_watch_log_group_arn="cloudWatchLogGroupArn",
                    log_prefix="logPrefix"
                )
            ),
            enabled=False
        )]
    ),
    description="description",
    sentiment_analysis_settings=sentiment_analysis_settings
)

Attributes

bot_alias_locale_settings

Specifies settings that are unique to a locale.

For example, you can use different Lambda function depending on the bot’s locale.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-botaliaslocalesettings

bot_alias_name

The name of the bot alias.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-botaliasname

bot_alias_tags

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-botaliastags

bot_id

The unique identifier of the bot.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-botid

bot_version

The version of the bot that the bot alias references.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-botversion

conversation_log_settings

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-conversationlogsettings

description

The description of the bot alias.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-description

sentiment_analysis_settings

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-botalias.html#cfn-lex-botalias-sentimentanalysissettings