CfnBotAliasProps Struct
Properties for defining a CfnBotAlias.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
declare const sentimentAnalysisSettings: any;
const cfnBotAliasProps: lex.CfnBotAliasProps = {
botAliasName: 'botAliasName',
botId: 'botId',
// the properties below are optional
botAliasLocaleSettings: [{
botAliasLocaleSetting: {
enabled: false,
// the properties below are optional
codeHookSpecification: {
lambdaCodeHook: {
codeHookInterfaceVersion: 'codeHookInterfaceVersion',
lambdaArn: 'lambdaArn',
},
},
},
localeId: 'localeId',
}],
botAliasTags: [{
key: 'key',
value: 'value',
}],
botVersion: 'botVersion',
conversationLogSettings: {
audioLogSettings: [{
destination: {
s3Bucket: {
logPrefix: 'logPrefix',
s3BucketArn: 's3BucketArn',
// the properties below are optional
kmsKeyArn: 'kmsKeyArn',
},
},
enabled: false,
}],
textLogSettings: [{
destination: {
cloudWatch: {
cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
logPrefix: 'logPrefix',
},
},
enabled: false,
}],
},
description: 'description',
sentimentAnalysisSettings: sentimentAnalysisSettings,
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lex;
var sentimentAnalysisSettings;
var cfnBotAliasProps = new CfnBotAliasProps {
BotAliasName = "botAliasName",
BotId = "botId",
// the properties below are optional
BotAliasLocaleSettings = new [] { new BotAliasLocaleSettingsItemProperty {
BotAliasLocaleSetting = new BotAliasLocaleSettingsProperty {
Enabled = false,
// the properties below are optional
CodeHookSpecification = new CodeHookSpecificationProperty {
LambdaCodeHook = new LambdaCodeHookProperty {
CodeHookInterfaceVersion = "codeHookInterfaceVersion",
LambdaArn = "lambdaArn"
}
}
},
LocaleId = "localeId"
} },
BotAliasTags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
BotVersion = "botVersion",
ConversationLogSettings = new ConversationLogSettingsProperty {
AudioLogSettings = new [] { new AudioLogSettingProperty {
Destination = new AudioLogDestinationProperty {
S3Bucket = new S3BucketLogDestinationProperty {
LogPrefix = "logPrefix",
S3BucketArn = "s3BucketArn",
// the properties below are optional
KmsKeyArn = "kmsKeyArn"
}
},
Enabled = false
} },
TextLogSettings = new [] { new TextLogSettingProperty {
Destination = new TextLogDestinationProperty {
CloudWatch = new CloudWatchLogGroupLogDestinationProperty {
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
LogPrefix = "logPrefix"
}
},
Enabled = false
} }
},
Description = "description",
SentimentAnalysisSettings = sentimentAnalysisSettings
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var sentimentAnalysisSettings interface{}
cfnBotAliasProps := &CfnBotAliasProps{
BotAliasName: jsii.String("botAliasName"),
BotId: jsii.String("botId"),
// the properties below are optional
BotAliasLocaleSettings: []interface{}{
&BotAliasLocaleSettingsItemProperty{
BotAliasLocaleSetting: &BotAliasLocaleSettingsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
CodeHookSpecification: &CodeHookSpecificationProperty{
LambdaCodeHook: &LambdaCodeHookProperty{
CodeHookInterfaceVersion: jsii.String("codeHookInterfaceVersion"),
LambdaArn: jsii.String("lambdaArn"),
},
},
},
LocaleId: jsii.String("localeId"),
},
},
BotAliasTags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
BotVersion: jsii.String("botVersion"),
ConversationLogSettings: &ConversationLogSettingsProperty{
AudioLogSettings: []interface{}{
&AudioLogSettingProperty{
Destination: &AudioLogDestinationProperty{
S3Bucket: &S3BucketLogDestinationProperty{
LogPrefix: jsii.String("logPrefix"),
S3BucketArn: jsii.String("s3BucketArn"),
// the properties below are optional
KmsKeyArn: jsii.String("kmsKeyArn"),
},
},
Enabled: jsii.Boolean(false),
},
},
TextLogSettings: []interface{}{
&TextLogSettingProperty{
Destination: &TextLogDestinationProperty{
CloudWatch: &CloudWatchLogGroupLogDestinationProperty{
CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
LogPrefix: jsii.String("logPrefix"),
},
},
Enabled: jsii.Boolean(false),
},
},
},
Description: jsii.String("description"),
SentimentAnalysisSettings: sentimentAnalysisSettings,
}
Properties
botAliasLocaleSettingsoptionalIResolvable | IResolvable | CfnBotAlias.BotAliasLocaleSettingsItemProperty[]bot_alias_locale_settingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BotAliasLocaleSettingsItemProperty]]]botAliasLocaleSettingsoptionalIResolvableBotAliasLocaleSettingsoptionalIResolvableBotAliasLocaleSettingsoptionalinterface{}#Specifies settings that are unique to a locale.
For example, you can use different Lambda function depending on the bot's locale.
The name of the bot alias.
botAliasTagsoptionalCfnTag[]bot_alias_tagsoptionaltyping.List[CfnTag]botAliasTagsoptionalList<CfnTag>BotAliasTagsoptionalCfnTag[]BotAliasTagsoptional*[]CfnTag#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 .
The unique identifier of the bot.
botVersionoptionalstringbot_versionoptionalstrbotVersionoptionalStringBotVersionoptionalstringBotVersionoptional*string#The version of the bot that the bot alias references.
conversationLogSettingsoptionalIResolvable | CfnBotAlias.ConversationLogSettingsPropertyconversation_log_settingsoptionaltyping.Union[IResolvable, ConversationLogSettingsProperty]conversationLogSettingsoptionalIResolvableConversationLogSettingsoptionalIResolvableConversationLogSettingsoptionalinterface{}#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 .
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description of the bot alias.
sentimentAnalysisSettingsoptionalanysentiment_analysis_settingsoptionalAnysentimentAnalysisSettingsoptionalObjectSentimentAnalysisSettingsoptionalobjectSentimentAnalysisSettingsoptionalinterface{}#Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.