software.amazon.awscdk.services.lex

Interface CfnBotAliasProps

All Known Implementing Classes:

CfnBotAliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:51.525Z")
public interface CfnBotAliasProps

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getBotAliasName

java.lang.String getBotAliasName()

The name of the bot alias.

getBotId

java.lang.String getBotId()

The unique identifier of the bot.

getBotAliasLocaleSettings

default java.lang.Object getBotAliasLocaleSettings()

Maps configuration information to a specific locale.

You can use this parameter to specify a specific Lambda function to run different functions in different locales.

getBotAliasTags

default java.lang.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 .

getBotVersion

default java.lang.String getBotVersion()

The version of the bot that the bot alias references.

getConversationLogSettings

default java.lang.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 .

getDescription

default java.lang.String getDescription()

The description of the bot alias.

getSentimentAnalysisSettings

default java.lang.Object getSentimentAnalysisSettings()

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

builder

static CfnBotAliasProps.Builder builder()

Returns:

a CfnBotAliasProps.Builder of CfnBotAliasProps