aws-cdk-lib.aws_lex.CfnBot.TestBotAliasSettingsProperty

TestBotAliasSettingsProperty Struct

Specifies configuration settings for the alias used to test the bot.

If the TestBotAliasSettings property is not specified, the settings are configured with default values.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// 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 testBotAliasSettingsProperty: lex.CfnBot.TestBotAliasSettingsProperty = {
  botAliasLocaleSettings: [{
    botAliasLocaleSetting: {
      enabled: false,

      // the properties below are optional
      codeHookSpecification: {
        lambdaCodeHook: {
          codeHookInterfaceVersion: 'codeHookInterfaceVersion',
          lambdaArn: 'lambdaArn',
        },
      },
    },
    localeId: 'localeId',
  }],
  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,
};

# 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

test_bot_alias_settings_property = lex.CfnBot.TestBotAliasSettingsProperty(
    bot_alias_locale_settings=[lex.CfnBot.BotAliasLocaleSettingsItemProperty(
        bot_alias_locale_setting=lex.CfnBot.BotAliasLocaleSettingsProperty(
            enabled=False,

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

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

// 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;

TestBotAliasSettingsProperty testBotAliasSettingsProperty = TestBotAliasSettingsProperty.builder()
        .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()))
        .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();

// 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 testBotAliasSettingsProperty = new TestBotAliasSettingsProperty {
    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"
    } },
    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
};

// 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{}

testBotAliasSettingsProperty := &TestBotAliasSettingsProperty{
	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"),
		},
	},
	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

botAliasLocaleSettings?optionalIResolvable | IResolvable | CfnBot.BotAliasLocaleSettingsItemProperty[]bot_alias_locale_settings?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BotAliasLocaleSettingsItemProperty]]]botAliasLocaleSettings?optionalIResolvableBotAliasLocaleSettings?optionalIResolvableBotAliasLocaleSettings?optionalinterface{}#

Specifies settings that are unique to a locale.

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

conversationLogSettings?optionalIResolvable | CfnBot.ConversationLogSettingsPropertyconversation_log_settings?optionaltyping.Union[IResolvable, ConversationLogSettingsProperty]conversationLogSettings?optionalIResolvableConversationLogSettings?optionalIResolvableConversationLogSettings?optionalinterface{}#

Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

Specifies a description for the test bot alias.

sentimentAnalysisSettings?optionalanysentiment_analysis_settings?optionalAnysentimentAnalysisSettings?optionalObjectSentimentAnalysisSettings?optionalobjectSentimentAnalysisSettings?optionalinterface{}#

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