Package software.amazon.awscdk.services.lex

Interface CfnBotAliasProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBotAliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:45.771Z")
@Stability(Stable)
public interface CfnBotAliasProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnBotAlias.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lex.*;
 Object sentimentAnalysisSettings;
 CfnBotAliasProps cfnBotAliasProps = CfnBotAliasProps.builder()
         .botAliasName("botAliasName")
         .botId("botId")
         // the properties below are optional
         .botAliasLocaleSettings(List.of(BotAliasLocaleSettingsItemProperty.builder()
                 .botAliasLocaleSetting(BotAliasLocaleSettingsProperty.builder()
                         .enabled(false)
                         // the properties below are optional
                         .codeHookSpecification(CodeHookSpecificationProperty.builder()
                                 .lambdaCodeHook(LambdaCodeHookProperty.builder()
                                         .codeHookInterfaceVersion("codeHookInterfaceVersion")
                                         .lambdaArn("lambdaArn")
                                         .build())
                                 .build())
                         .build())
                 .localeId("localeId")
                 .build()))
         .botAliasTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .botVersion("botVersion")
         .conversationLogSettings(ConversationLogSettingsProperty.builder()
                 .audioLogSettings(List.of(AudioLogSettingProperty.builder()
                         .destination(AudioLogDestinationProperty.builder()
                                 .s3Bucket(S3BucketLogDestinationProperty.builder()
                                         .logPrefix("logPrefix")
                                         .s3BucketArn("s3BucketArn")
                                         // the properties below are optional
                                         .kmsKeyArn("kmsKeyArn")
                                         .build())
                                 .build())
                         .enabled(false)
                         .build()))
                 .textLogSettings(List.of(TextLogSettingProperty.builder()
                         .destination(TextLogDestinationProperty.builder()
                                 .cloudWatch(CloudWatchLogGroupLogDestinationProperty.builder()
                                         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                                         .logPrefix("logPrefix")
                                         .build())
                                 .build())
                         .enabled(false)
                         .build()))
                 .build())
         .description("description")
         .sentimentAnalysisSettings(sentimentAnalysisSettings)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBotAliasProps.Builder	A builder for CfnBotAliasProps
static final class	CfnBotAliasProps.Jsii$Proxy	An implementation for CfnBotAliasProps

Method Summary

Modifier and Type	Method	Description
static CfnBotAliasProps.Builder	builder()
default Object	getBotAliasLocaleSettings()	Specifies settings that are unique to a locale.
String	getBotAliasName()	The name of the bot alias.
default Object	getBotAliasTags()	An array of key-value pairs to apply to this resource.
String	getBotId()	The unique identifier of the bot.
default String	getBotVersion()	The version of the bot that the bot alias references.
default Object	getConversationLogSettings()	Specifies whether Amazon Lex logs text and audio for conversations with the bot.
default String	getDescription()	The description of the bot alias.
default Object	getSentimentAnalysisSettings()	Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBotAliasName

@Stability(Stable)
@NotNull
String getBotAliasName()

The name of the bot alias.

See Also:

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

getBotId

@Stability(Stable)
@NotNull
String getBotId()

The unique identifier of the bot.

See Also:

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

getBotAliasLocaleSettings

@Stability(Stable)
@Nullable
default Object getBotAliasLocaleSettings()

Specifies settings that are unique to a locale.

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

See Also:

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

getBotAliasTags

@Stability(Stable)
@Nullable
default Object getBotAliasTags()

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 .

See Also:

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

getBotVersion

@Stability(Stable)
@Nullable
default String getBotVersion()

The version of the bot that the bot alias references.

See Also:

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

getConversationLogSettings

@Stability(Stable)
@Nullable
default Object getConversationLogSettings()

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 .

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the bot alias.

See Also:

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

getSentimentAnalysisSettings

@Stability(Stable)
@Nullable
default Object getSentimentAnalysisSettings()

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

See Also:

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

builder

@Stability(Stable)
static CfnBotAliasProps.Builder builder()

Returns:

a CfnBotAliasProps.Builder of CfnBotAliasProps