Package software.amazon.awscdk.services.lex

Interface CfnBotProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBotProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:34.944Z")
@Stability(Stable)
public interface CfnBotProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnBot.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBotProps.Builder	builder()
default Object	getAutoBuildBotLocales()	Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.
default Object	getBotFileS3Location()	The Amazon S3 location of files used to import a bot.
default Object	getBotLocales()	A list of locales for the bot.
default Object	getBotTags()	A list of tags to add to the bot.
Object	getDataPrivacy()	By default, data stored by Amazon Lex is encrypted.
default String	getDescription()	The description of the version.
Number	getIdleSessionTtlInSeconds()	The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
String	getName()	The name of the bot locale.
default Object	getReplication()
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
default Object	getTestBotAliasSettings()	Specifies configuration settings for the alias used to test the bot.
default Object	getTestBotAliasTags()	A list of tags to add to the test alias for a bot.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataPrivacy

@Stability(Stable)
@NotNull
Object getDataPrivacy()

By default, data stored by Amazon Lex is encrypted.

The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

See Also:

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

getIdleSessionTtlInSeconds

@Stability(Stable)
@NotNull
Number getIdleSessionTtlInSeconds()

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the bot locale.

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

See Also:

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

getAutoBuildBotLocales

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

Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.

See Also:

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

getBotFileS3Location

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

The Amazon S3 location of files used to import a bot.

The files must be in the import format specified in JSON format for importing and exporting in the Amazon Lex developer guide.

See Also:

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

getBotLocales

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

A list of locales for the bot.

See Also:

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

getBotTags

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

A list of tags to add to the bot.

You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

See Also:

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

getDescription

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

The description of the version.

See Also:

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

getReplication

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

See Also:

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

getTestBotAliasSettings

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

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.

See Also:

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

getTestBotAliasTags

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

A list of tags to add to the test alias for a bot.

You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

See Also:

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

builder

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

Returns:

a CfnBotProps.Builder of CfnBotProps