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.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:13.219Z")
@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	getBotMembers()	The list of bot members in a network to be created.
default List<CfnTag>	getBotTags()	A list of tags to add to the bot.
default String	getBotType()	The type of a bot to create.
Object	getDataPrivacy()	By default, data stored by Amazon Lex is encrypted.
default String	getDescription()	The description of the version.
default Object	getErrorLogSettings()	Returns union: either IResolvable or CfnBot.ErrorLogSettingsProperty
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()	Returns union: either IResolvable or CfnBot.ReplicationProperty
Object	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
Object getRoleArn()

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

Returns union: either String or IRoleRef

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.

Returns union: either Boolean or IResolvable

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.

Returns union: either IResolvable or CfnBot.S3LocationProperty

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBot.BotLocaleProperty>

See Also:

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

getBotMembers

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

The list of bot members in a network to be created.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBot.BotMemberProperty>

See Also:

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

getBotTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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

getBotType

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

The type of a bot to create.

Default: - "Bot"

See Also:

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

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

getErrorLogSettings

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

Returns union: either IResolvable or CfnBot.ErrorLogSettingsProperty

See Also:

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

getReplication

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

Returns union: either IResolvable or CfnBot.ReplicationProperty

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.

Returns union: either IResolvable or CfnBot.TestBotAliasSettingsProperty

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTag>

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