CfnBotProps
- class aws_cdk.aws_lex.CfnBotProps(*, data_privacy, idle_session_ttl_in_seconds, name, role_arn, auto_build_bot_locales=None, bot_file_s3_location=None, bot_locales=None, bot_tags=None, description=None, test_bot_alias_settings=None, test_bot_alias_tags=None)
Bases:
object
Properties for defining a
CfnBot
.- Parameters:
data_privacy (
Any
) – By default, data stored by Amazon Lex is encrypted. TheDataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.idle_session_ttl_in_seconds (
Union
[int
,float
]) – 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.name (
str
) – The name of the bot locale.role_arn (
str
) – The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.auto_build_bot_locales (
Union
[bool
,IResolvable
,None
]) – Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.bot_file_s3_location (
Union
[IResolvable
,S3LocationProperty
,Dict
[str
,Any
],None
]) – 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.bot_locales (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,BotLocaleProperty
,Dict
[str
,Any
]]],None
]) – A list of locales for the bot.bot_tags (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CfnTag
,Dict
[str
,Any
]]],None
]) – A list of tags to add to the bot. You can only add tags when you import a bot. You can’t use theUpdateBot
operation to update tags. To update tags, use theTagResource
operation.description (
Optional
[str
]) – The description of the version.test_bot_alias_settings (
Union
[IResolvable
,TestBotAliasSettingsProperty
,Dict
[str
,Any
],None
]) – Specifies configuration settings for the alias used to test the bot. If theTestBotAliasSettings
property is not specified, the settings are configured with default values.test_bot_alias_tags (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CfnTag
,Dict
[str
,Any
]]],None
]) – 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 theUpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-bot.html
- ExampleMetadata:
fixture=_generated
Example:
.. rubric:: Attributes
- auto_build_bot_locales
Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.
- bot_file_s3_location
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.
- bot_locales
A list of locales for the bot.
- bot_tags
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 theTagResource
operation.
- data_privacy
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.
- description
The description of the version.
- idle_session_ttl_in_seconds
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.
- name
The name of the bot locale.
- role_arn
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
- test_bot_alias_settings
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.
- test_bot_alias_tags
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 theTagResource
operation.