interface CfnBotProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Lex.CfnBotProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBotProps |
 Java | software.amazon.awscdk.services.lex.CfnBotProps |
 Python | aws_cdk.aws_lex.CfnBotProps |
 TypeScript | aws-cdk-lib » aws_lex » CfnBotProps |
Properties for defining a CfnBot.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-bot.html
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Properties
| Name | Type | Description |
|---|---|---|
| data | any | By default, data stored by Amazon Lex is encrypted. |
| idle | number | The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. |
| name | string | The name of the bot locale. |
| role | string | The Amazon Resource Name (ARN) of the IAM role used to build and run the bot. |
| auto | boolean | IResolvable | Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change. |
| bot | IResolvable | S3 | The Amazon S3 location of files used to import a bot. |
| bot | IResolvable | IResolvable | Bot[] | A list of locales for the bot. |
| bot | IResolvable | IResolvable | Cfn[] | A list of tags to add to the bot. |
| description? | string | The description of the version. |
| test | IResolvable | Test | Specifies configuration settings for the alias used to test the bot. |
| test | IResolvable | IResolvable | Cfn[] | A list of tags to add to the test alias for a bot. |
dataPrivacy
Type:
any
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.
idleSessionTtlInSeconds
Type:
number
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
Type:
string
The name of the bot locale.
roleArn
Type:
string
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
autoBuildBotLocales?
Type:
boolean | IResolvable
(optional)
Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.
botFileS3Location?
Type:
IResolvable | S3
(optional)
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.
botLocales?
Type:
IResolvable | IResolvable | Bot[]
(optional)
A list of locales for the bot.
botTags?
Type:
IResolvable | IResolvable | Cfn[]
(optional)
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.
description?
Type:
string
(optional)
The description of the version.
testBotAliasSettings?
Type:
IResolvable | Test
(optional)
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.
testBotAliasTags?
Type:
IResolvable | IResolvable | Cfn[]
(optional)
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.