Class CfnBot
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.lex.CfnBot
- All Implemented Interfaces:
IInspectable,IBotRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-29T11:15:42.814Z")
@Stability(Stable)
public class CfnBot
extends CfnResource
implements IInspectable, IBotRef
Amazon Lex V2 is the only supported version in AWS CloudFormation .
Specifies an Amazon Lex conversational bot.
You must configure an intent based on the AMAZON.FallbackIntent built-in intent. If you don't add one, creating the bot will fail.
Example:
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceProvides settings that enable advanced recognition settings for slot values.static interfaceSpecifies the allowed input types.static interfaceSpecifies the audio and DTMF input specification.static interfaceThe location of audio log files collected when conversation logging is enabled for a bot.static interfaceSettings for logging audio of conversations between Amazon Lex and a user.static interfaceSpecifies the audio input specifications.static interfaceExample:static interfaceExample:static interfaceExample:static interfaceThe details on the Bedrock guardrail configuration.static interfaceContains details about the configuration of a Amazon Bedrock knowledge base.static interfaceContains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.static interfaceExample:static interfaceSpecifies locale settings for a single locale.static interfaceSpecifies settings that are unique to a locale.static interfaceProvides configuration information for a locale.static final classA fluent builder forCfnBot.static interfaceContains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.static interfaceDescribes a button to use on a response card used to gather slot values from a user.static interfaceThe Amazon CloudWatch Logs log group where the text and metadata logs are delivered.static interfaceContains information about code hooks that Amazon Lex calls during a conversation.static interfaceA composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.static interfaceA set of actions that Amazon Lex should run if the condition is matched.static interfaceProvides a list of conditional branches.static interfaceProvides an expression that evaluates to true or false.static interfaceConfigures conversation logging that saves audio, text, and metadata for the conversations with your users.static interfaceA custom response string that Amazon Lex sends to your application.static interfaceSpecifies an entry in a custom vocabulary.static interfaceSpecifies a custom vocabulary.static interfaceBy default, data stored by Amazon Lex is encrypted.static interfaceContains details about the configuration of the knowledge store used for theAMAZON.QnAIntent.static interfaceA set of actions that Amazon Lex should run if none of the other conditions are met.static interfaceContains specifications for the descriptive bot building feature.static interfaceDefines the action that the bot executes at runtime when the conversation reaches this step.static interfaceSettings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.static interfaceSettings that determine the Lambda function that Amazon Lex uses for processing user responses.static interfaceThe current state of the conversation with the user.static interfaceSpecifies the DTMF input specifications.static interfaceSettings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.static interfaceExample:static interfaceContains the names of the fields used for an exact response to the user.static interfaceProvides information about the external source of the slot type's definition.static interfaceDetermines if a Lambda function should be invoked for a specific intent.static interfaceProvides settings for a message that is sent to the user when a fulfillment Lambda function starts running.static interfaceProvides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.static interfaceProvides information for updating the user on the progress of fulfilling an intent.static interfaceContains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.static interfaceSettings requried for a slot type based on a grammar that you provide.static interfaceDescribes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.static interfaceA card that is shown to the user by a messaging platform.static interfaceConfiguration setting for a response sent to the user before Amazon Lex starts eliciting slots.static interfaceA context that must be active for an intent to be selected by Amazon Lex.static interfaceProvides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.static interfaceProvides a prompt for making sure that the user is ready for the intent to be fulfilled.static interfaceOverride settings to configure the intent state.static interfaceRepresents an action that the user wants to perform.static interfaceProvides configuration information for theAMAZON.KendraSearchIntentintent.static interfaceSpecifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.static interfaceProvides one or more messages that Amazon Lex should send to the user.static interfaceThe object that provides message text and its type.static interfaceIndicates whether a slot can return multiple values.static interfaceConfigures the Assisted Natural Language Understanding (NLU) feature for your bot.static interfaceDetermines whether Amazon Lex obscures slot values in conversation logs.static interfaceContains details about the configuration of the Amazon OpenSearch Service database used for theAMAZON.QnAIntent.static interfaceDescribes a session context that is activated when an intent is fulfilled.static interfaceDefines an ASCII text message to send to the user.static interfaceSpecifies next steps to run after the dialog code hook finishes.static interfaceProvides a setting that determines whether the post-fulfillment response is sent to the user.static interfaceSpecifies the settings on a prompt attempt.static interfaceSpecifies a list of message groups that Amazon Lex sends to a user to elicit a response.static interfaceExample:static interfaceExample:static interfaceDetails about the the configuration of the built-inAmazon.QnAIntent.static interfaceContains details about the configuration of the Amazon Kendra index used for theAMAZON.QnAIntent.static interfaceExample:static interfaceSpecifies a list of message groups that Amazon Lex uses to respond the user input.static interfaceContains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.static interfaceSpecifies an Amazon S3 bucket for logging audio conversations.static interfaceDefines an Amazon S3 bucket location.static interfaceContains specifications for the sample utterance generation feature.static interfaceA sample utterance that invokes an intent or respond to a slot elicitation prompt.static interfaceDefines one of the values for a slot type.static interfaceDetermines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.static interfaceA key/value pair representing session-specific context information.static interfaceSettings used when Amazon Lex successfully captures a slot value from a user.static interfaceSpecifies the default value to use when a user doesn't provide a value for a slot.static interfaceThe default value to use when a user doesn't provide a value for a slot.static interfaceSets the priority that Amazon Lex should use when eliciting slot values from a user.static interfaceSpecifies the definition of a slot.static interfaceContains specifications for the assisted slot resolution feature.static interfaceDescribes a slot type.static interfaceEach slot type can have a set of values.static interfaceSpecifies the elicitation setting details eliciting a slot.static interfaceMaps a slot name to the SlotValueOverride object.static interfaceThe slot values that Amazon Lex uses when it sets slot values in a dialog step.static interfaceThe value to set in a slot.static interfaceProvides a regular expression used to validate the value of a slot.static interfaceContains settings used by Amazon Lex to select a slot value.static interfaceSubslot specifications.static interfaceDefines a Speech Synthesis Markup Language (SSML) prompt.static interfaceDefines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.static interfaceSpecifications for the constituent sub slots and the expression for the composite slot.static interfaceSubslot type composition.static interfaceSubslot elicitation settings.static interfaceSpecifies configuration settings for the alias used to test the bot.static interfaceSpecifies the text input specifications.static interfaceDefines the Amazon CloudWatch Logs destination log group for conversation text logs.static interfaceDefines settings to enable text conversation logs.static interfaceDefines settings for using an Amazon Polly voice to communicate with a user.static interfaceSpecifies the prompts that Amazon Lex uses while a bot is waiting for customer input.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.lex.IBotRef
IBotRef.Jsii$Default, IBotRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnBot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnBot(software.amazon.jsii.JsiiObjectRef objRef) CfnBot(software.constructs.Construct scope, String id, CfnBotProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the bot.The unique identifier of the bot.Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.The Amazon S3 location of files used to import a bot.A list of locales for the bot.A reference to a Bot resource.A list of tags to add to the bot.By default, data stored by Amazon Lex is encrypted.The description of the version.Returns union: eitherIResolvableorCfnBot.ErrorLogSettingsPropertyThe time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.getName()The name of the bot locale.Returns union: eitherIResolvableorCfnBot.ReplicationPropertyThe Amazon Resource Name (ARN) of the IAM role used to build and run the bot.Specifies configuration settings for the alias used to test the bot.A list of tags to add to the test alias for a bot.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetAutoBuildBotLocales(Boolean value) Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.voidIndicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.voidsetBotFileS3Location(IResolvable value) The Amazon S3 location of files used to import a bot.voidThe Amazon S3 location of files used to import a bot.voidsetBotLocales(List<Object> value) A list of locales for the bot.voidsetBotLocales(IResolvable value) A list of locales for the bot.voidsetBotTags(List<Object> value) A list of tags to add to the bot.voidsetBotTags(IResolvable value) A list of tags to add to the bot.voidsetDataPrivacy(Object value) By default, data stored by Amazon Lex is encrypted.voidsetDescription(String value) The description of the version.voidsetErrorLogSettings(IResolvable value) voidvoidsetIdleSessionTtlInSeconds(Number value) The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.voidThe name of the bot locale.voidsetReplication(IResolvable value) voidvoidsetRoleArn(String value) The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.voidSpecifies configuration settings for the alias used to test the bot.voidSpecifies configuration settings for the alias used to test the bot.voidsetTestBotAliasTags(List<Object> value) A list of tags to add to the test alias for a bot.voidsetTestBotAliasTags(IResolvable value) A list of tags to add to the test alias for a bot.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnBot
protected CfnBot(software.amazon.jsii.JsiiObjectRef objRef) -
CfnBot
protected CfnBot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnBot
@Stability(Stable) public CfnBot(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnBotProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the bot. -
getAttrId
The unique identifier of the bot. -
getBotRef
A reference to a Bot resource. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getDataPrivacy
By default, data stored by Amazon Lex is encrypted. -
setDataPrivacy
By default, data stored by Amazon Lex is encrypted. -
getIdleSessionTtlInSeconds
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. -
setIdleSessionTtlInSeconds
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. -
getName
The name of the bot locale. -
setName
The name of the bot locale. -
getRoleArn
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot. -
setRoleArn
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot. -
getAutoBuildBotLocales
Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.Returns union: either
BooleanorIResolvable -
setAutoBuildBotLocales
Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change. -
setAutoBuildBotLocales
Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change. -
getBotFileS3Location
The Amazon S3 location of files used to import a bot.Returns union: either
IResolvableorCfnBot.S3LocationProperty -
setBotFileS3Location
The Amazon S3 location of files used to import a bot. -
setBotFileS3Location
The Amazon S3 location of files used to import a bot. -
getBotLocales
A list of locales for the bot.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnBot.BotLocaleProperty> -
setBotLocales
A list of locales for the bot. -
setBotLocales
A list of locales for the bot. -
getBotTags
A list of tags to add to the bot.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTag> -
setBotTags
A list of tags to add to the bot. -
setBotTags
A list of tags to add to the bot. -
getDescription
The description of the version. -
setDescription
The description of the version. -
getErrorLogSettings
Returns union: eitherIResolvableorCfnBot.ErrorLogSettingsProperty -
setErrorLogSettings
-
setErrorLogSettings
-
getReplication
Returns union: eitherIResolvableorCfnBot.ReplicationProperty -
setReplication
-
setReplication
-
getTestBotAliasSettings
Specifies configuration settings for the alias used to test the bot.Returns union: either
IResolvableorCfnBot.TestBotAliasSettingsProperty -
setTestBotAliasSettings
Specifies configuration settings for the alias used to test the bot. -
setTestBotAliasSettings
@Stability(Stable) public void setTestBotAliasSettings(@Nullable CfnBot.TestBotAliasSettingsProperty value) Specifies configuration settings for the alias used to test the bot. -
getTestBotAliasTags
A list of tags to add to the test alias for a bot.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTag> -
setTestBotAliasTags
A list of tags to add to the test alias for a bot. -
setTestBotAliasTags
A list of tags to add to the test alias for a bot.
-