CfnBotAlias

class aws_cdk.aws_lex.CfnBotAlias(scope, id, *, 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: CfnResource

A CloudFormation AWS::Lex::BotAlias.

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.

CloudformationResource:: AWS::Lex::BotAlias
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 = lex.CfnBotAlias(self, "MyCfnBotAlias",
    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
)

Create a new AWS::Lex::BotAlias.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Lex::BotAlias'

attr_arn

The Amazon Resource Name (ARN) of the bot alias.

CloudformationAttribute:: Arn

attr_bot_alias_id

The unique identifier of the bot alias.

CloudformationAttribute:: BotAliasId

attr_bot_alias_status

The current status of the bot alias.

When the status is Available the alias is ready for use with your bot.

CloudformationAttribute:: BotAliasStatus

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

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

AudioLogDestinationProperty

class CfnBotAlias.AudioLogDestinationProperty(*, s3_bucket)

Bases: object

Specifies the S3 bucket location where audio logs are stored.

Parameters:: s3_bucket (Union[IResolvable, S3BucketLogDestinationProperty, Dict[str, Any]]) – The S3 bucket location where audio logs are stored.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-audiologdestination.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

audio_log_destination_property = lex.CfnBotAlias.AudioLogDestinationProperty(
    s3_bucket=lex.CfnBotAlias.S3BucketLogDestinationProperty(
        log_prefix="logPrefix",
        s3_bucket_arn="s3BucketArn",

        # the properties below are optional
        kms_key_arn="kmsKeyArn"
    )
)

Attributes

s3_bucket

The S3 bucket location where audio logs are stored.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-audiologdestination.html#cfn-lex-botalias-audiologdestination-s3bucket

AudioLogSettingProperty

class CfnBotAlias.AudioLogSettingProperty(*, destination, enabled)

Bases: object

Settings for logging audio of conversations between Amazon Lex and a user.

You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.

Parameters:

destination (Union[IResolvable, AudioLogDestinationProperty, Dict[str, Any]]) – The location of audio log files collected when conversation logging is enabled for a bot.
enabled (Union[bool, IResolvable]) – Determines whether audio logging in enabled for the bot.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-audiologsetting.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

audio_log_setting_property = 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
)

Attributes

destination

The location of audio log files collected when conversation logging is enabled for a bot.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-audiologsetting.html#cfn-lex-botalias-audiologsetting-destination

enabled

Determines whether audio logging in enabled for the bot.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-audiologsetting.html#cfn-lex-botalias-audiologsetting-enabled

BotAliasLocaleSettingsItemProperty

class CfnBotAlias.BotAliasLocaleSettingsItemProperty(*, bot_alias_locale_setting, locale_id)

Bases: object

Specifies settings that are unique to a locale.

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

Parameters:

bot_alias_locale_setting (Union[IResolvable, BotAliasLocaleSettingsProperty, Dict[str, Any]]) – Specifies settings that are unique to a locale.
locale_id (str) – The unique identifier of the locale.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.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

bot_alias_locale_settings_item_property = 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"
)

Attributes

bot_alias_locale_setting

Specifies settings that are unique to a locale.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html#cfn-lex-botalias-botaliaslocalesettingsitem-botaliaslocalesetting

locale_id

The unique identifier of the locale.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html#cfn-lex-botalias-botaliaslocalesettingsitem-localeid

BotAliasLocaleSettingsProperty

class CfnBotAlias.BotAliasLocaleSettingsProperty(*, enabled, code_hook_specification=None)

Bases: object

Specifies settings that are unique to a locale.

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

Parameters:

enabled (Union[bool, IResolvable]) – Determines whether the locale is enabled for the bot. If the value is false , the locale isn’t available for use.
code_hook_specification (Union[IResolvable, CodeHookSpecificationProperty, Dict[str, Any], None]) – Specifies the Lambda function that should be used in the locale.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.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

bot_alias_locale_settings_property = 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"
        )
    )
)

Attributes

code_hook_specification

Specifies the Lambda function that should be used in the locale.

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

enabled

Determines whether the locale is enabled for the bot.

If the value is false , the locale isn’t available for use.

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

CloudWatchLogGroupLogDestinationProperty

class CfnBotAlias.CloudWatchLogGroupLogDestinationProperty(*, cloud_watch_log_group_arn, log_prefix)

Bases: object

The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.

The log group must exist before you enable logging.

Parameters:

cloud_watch_log_group_arn (str) – The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
log_prefix (str) – The prefix of the log stream name within the log group that you specified.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-cloudwatchloggrouplogdestination.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

cloud_watch_log_group_log_destination_property = lex.CfnBotAlias.CloudWatchLogGroupLogDestinationProperty(
    cloud_watch_log_group_arn="cloudWatchLogGroupArn",
    log_prefix="logPrefix"
)

Attributes

cloud_watch_log_group_arn

The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-cloudwatchloggrouplogdestination.html#cfn-lex-botalias-cloudwatchloggrouplogdestination-cloudwatchloggrouparn

log_prefix

The prefix of the log stream name within the log group that you specified.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-cloudwatchloggrouplogdestination.html#cfn-lex-botalias-cloudwatchloggrouplogdestination-logprefix

CodeHookSpecificationProperty

class CfnBotAlias.CodeHookSpecificationProperty(*, lambda_code_hook)

Bases: object

Contains information about code hooks that Amazon Lex calls during a conversation.

Parameters:: lambda_code_hook (Union[IResolvable, LambdaCodeHookProperty, Dict[str, Any]]) – Specifies a Lambda function that verifies requests to a bot or fulfills the user’s request to a bot.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-codehookspecification.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

code_hook_specification_property = lex.CfnBotAlias.CodeHookSpecificationProperty(
    lambda_code_hook=lex.CfnBotAlias.LambdaCodeHookProperty(
        code_hook_interface_version="codeHookInterfaceVersion",
        lambda_arn="lambdaArn"
    )
)

Attributes

lambda_code_hook

Specifies a Lambda function that verifies requests to a bot or fulfills the user’s request to a bot.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-codehookspecification.html#cfn-lex-botalias-codehookspecification-lambdacodehook

ConversationLogSettingsProperty

class CfnBotAlias.ConversationLogSettingsProperty(*, audio_log_settings=None, text_log_settings=None)

Bases: object

Configures conversation logging that saves audio, text, and metadata for the conversations with your users.

Parameters:

audio_log_settings (Union[IResolvable, Sequence[Union[IResolvable, AudioLogSettingProperty, Dict[str, Any]]], None]) – The Amazon S3 settings for logging audio to an S3 bucket.
text_log_settings (Union[IResolvable, Sequence[Union[IResolvable, TextLogSettingProperty, Dict[str, Any]]], None]) – The Amazon CloudWatch Logs settings for logging text and metadata.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-conversationlogsettings.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

conversation_log_settings_property = 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
    )]
)

Attributes

audio_log_settings

The Amazon S3 settings for logging audio to an S3 bucket.

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

text_log_settings

The Amazon CloudWatch Logs settings for logging text and metadata.

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

LambdaCodeHookProperty

class CfnBotAlias.LambdaCodeHookProperty(*, code_hook_interface_version, lambda_arn)

Bases: object

Specifies a Lambda function that verifies requests to a bot or fulfills the user’s request to a bot.

Parameters:

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-lambdacodehook.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

lambda_code_hook_property = lex.CfnBotAlias.LambdaCodeHookProperty(
    code_hook_interface_version="codeHookInterfaceVersion",
    lambda_arn="lambdaArn"
)

Attributes

code_hook_interface_version

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-lambdacodehook.html#cfn-lex-botalias-lambdacodehook-codehookinterfaceversion

lambda_arn

The Amazon Resource Name (ARN) of the Lambda function.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-lambdacodehook.html#cfn-lex-botalias-lambdacodehook-lambdaarn

S3BucketLogDestinationProperty

class CfnBotAlias.S3BucketLogDestinationProperty(*, log_prefix, s3_bucket_arn, kms_key_arn=None)

Bases: object

Specifies an Amazon S3 bucket for logging audio conversations.

Parameters:

log_prefix (str) – The S3 prefix to assign to audio log files.
s3_bucket_arn (str) – The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an Amazon S3 bucket.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-s3bucketlogdestination.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

s3_bucket_log_destination_property = lex.CfnBotAlias.S3BucketLogDestinationProperty(
    log_prefix="logPrefix",
    s3_bucket_arn="s3BucketArn",

    # the properties below are optional
    kms_key_arn="kmsKeyArn"
)

Attributes

kms_key_arn

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an Amazon S3 bucket.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-s3bucketlogdestination.html#cfn-lex-botalias-s3bucketlogdestination-kmskeyarn

log_prefix

The S3 prefix to assign to audio log files.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-s3bucketlogdestination.html#cfn-lex-botalias-s3bucketlogdestination-logprefix

s3_bucket_arn

The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-s3bucketlogdestination.html#cfn-lex-botalias-s3bucketlogdestination-s3bucketarn

SentimentAnalysisSettingsProperty

class CfnBotAlias.SentimentAnalysisSettingsProperty(*, detect_sentiment)

Bases: object

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

Parameters:: detect_sentiment (Union[bool, IResolvable]) – Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-sentimentanalysissettings.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_property = lex.CfnBotAlias.SentimentAnalysisSettingsProperty(
    detect_sentiment=False
)

Attributes

detect_sentiment

Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

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

TextLogDestinationProperty

class CfnBotAlias.TextLogDestinationProperty(*, cloud_watch)

Bases: object

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

Parameters:: cloud_watch (Union[IResolvable, CloudWatchLogGroupLogDestinationProperty, Dict[str, Any]]) – Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-textlogdestination.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

text_log_destination_property = lex.CfnBotAlias.TextLogDestinationProperty(
    cloud_watch=lex.CfnBotAlias.CloudWatchLogGroupLogDestinationProperty(
        cloud_watch_log_group_arn="cloudWatchLogGroupArn",
        log_prefix="logPrefix"
    )
)

Attributes

cloud_watch

Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-textlogdestination.html#cfn-lex-botalias-textlogdestination-cloudwatch

TextLogSettingProperty

class CfnBotAlias.TextLogSettingProperty(*, destination, enabled)

Bases: object

Defines settings to enable text conversation logs.

Parameters:

destination (Union[IResolvable, TextLogDestinationProperty, Dict[str, Any]]) – Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
enabled (Union[bool, IResolvable]) – Determines whether conversation logs should be stored for an alias.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-textlogsetting.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

text_log_setting_property = lex.CfnBotAlias.TextLogSettingProperty(
    destination=lex.CfnBotAlias.TextLogDestinationProperty(
        cloud_watch=lex.CfnBotAlias.CloudWatchLogGroupLogDestinationProperty(
            cloud_watch_log_group_arn="cloudWatchLogGroupArn",
            log_prefix="logPrefix"
        )
    ),
    enabled=False
)

Attributes

destination

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-textlogsetting.html#cfn-lex-botalias-textlogsetting-destination

enabled

Determines whether conversation logs should be stored for an alias.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-textlogsetting.html#cfn-lex-botalias-textlogsetting-enabled