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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-17T21:37:33.556Z")
@Stability(Stable)
public class CfnBot
extends CfnResource
implements IInspectable
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
Modifier and TypeClassDescriptionstatic interface
Provides settings that enable advanced recognition settings for slot values.static interface
Specifies the allowed input types.static interface
Specifies the audio and DTMF input specification.static interface
The location of audio log files collected when conversation logging is enabled for a bot.static interface
Settings for logging audio of conversations between Amazon Lex and a user.static interface
Specifies the audio input specifications.static interface
Specifies locale settings for a single locale.static interface
Specifies settings that are unique to a locale.static interface
Provides configuration information for a locale.static final class
A fluent builder forCfnBot
.static interface
Describes a button to use on a response card used to gather slot values from a user.static interface
The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.static interface
Contains information about code hooks that Amazon Lex calls during a conversation.static interface
A set of actions that Amazon Lex should run if the condition is matched.static interface
Provides a list of conditional branches.static interface
Provides an expression that evaluates to true or false.static interface
Configures conversation logging that saves audio, text, and metadata for the conversations with your users.static interface
A custom response string that Amazon Lex sends to your application.static interface
Specifies an entry in a custom vocabulary.static interface
Specifies a custom vocabulary.static interface
By default, data stored by Amazon Lex is encrypted.static interface
A set of actions that Amazon Lex should run if none of the other conditions are met.static interface
Defines the action that the bot executes at runtime when the conversation reaches this step.static interface
Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.static interface
Settings that determine the Lambda function that Amazon Lex uses for processing user responses.static interface
The current state of the conversation with the user.static interface
Specifies the DTMF input specifications.static interface
Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.static interface
Provides information about the external source of the slot type's definition.static interface
Determines if a Lambda function should be invoked for a specific intent.static interface
Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.static interface
Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.static interface
Provides information for updating the user on the progress of fulfilling an intent.static interface
Settings requried for a slot type based on a grammar that you provide.static interface
Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.static interface
A card that is shown to the user by a messaging platform.static interface
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.static interface
A context that must be active for an intent to be selected by Amazon Lex.static interface
Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.static interface
Provides a prompt for making sure that the user is ready for the intent to be fulfilled.static interface
Override settings to configure the intent state.static interface
Represents an action that the user wants to perform.static interface
Provides configuration information for theAMAZON.KendraSearchIntent
intent.static interface
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.static interface
Provides one or more messages that Amazon Lex should send to the user.static interface
The object that provides message text and its type.static interface
Indicates whether a slot can return multiple values.static interface
Determines whether Amazon Lex obscures slot values in conversation logs.static interface
Describes a session context that is activated when an intent is fulfilled.static interface
Defines an ASCII text message to send to the user.static interface
Specifies next steps to run after the dialog code hook finishes.static interface
Provides a setting that determines whether the post-fulfillment response is sent to the user.static interface
Specifies the settings on a prompt attempt.static interface
Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.static interface
Specifies a list of message groups that Amazon Lex uses to respond the user input.static interface
Specifies an Amazon S3 bucket for logging audio conversations.static interface
Defines an Amazon S3 bucket location.static interface
A sample utterance that invokes an intent or respond to a slot elicitation prompt.static interface
Defines one of the values for a slot type.static interface
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.static interface
A key/value pair representing session-specific context information.static interface
Settings used when Amazon Lex successfully captures a slot value from a user.static interface
Specifies the default value to use when a user doesn't provide a value for a slot.static interface
The default value to use when a user doesn't provide a value for a slot.static interface
Sets the priority that Amazon Lex should use when eliciting slot values from a user.static interface
Specifies the definition of a slot.static interface
Describes a slot type.static interface
Each slot type can have a set of values.static interface
Specifies the elicitation setting details eliciting a slot.static interface
Maps a slot name to the SlotValueOverride object.static interface
The slot values that Amazon Lex uses when it sets slot values in a dialog step.static interface
The value to set in a slot.static interface
Provides a regular expression used to validate the value of a slot.static interface
Contains settings used by Amazon Lex to select a slot value.static interface
Defines a Speech Synthesis Markup Language (SSML) prompt.static interface
Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.static interface
Specifies configuration settings for the alias used to test the bot.static interface
Specifies the text input specifications.static interface
Defines the Amazon CloudWatch Logs destination log group for conversation text logs.static interface
Defines settings to enable text conversation logs.static interface
Defines settings for using an Amazon Polly voice to communicate with a user.static interface
Specifies 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.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnBot
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnBot
(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 list of tags to add to the bot.By default, data stored by Amazon Lex is encrypted.The description of the version.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.The 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.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAutoBuildBotLocales
(Boolean value) Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.void
Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.void
setBotFileS3Location
(IResolvable value) The Amazon S3 location of files used to import a bot.void
The Amazon S3 location of files used to import a bot.void
setBotLocales
(List<Object> value) A list of locales for the bot.void
setBotLocales
(IResolvable value) A list of locales for the bot.void
setBotTags
(List<Object> value) A list of tags to add to the bot.void
setBotTags
(IResolvable value) A list of tags to add to the bot.void
setDataPrivacy
(Object value) By default, data stored by Amazon Lex is encrypted.void
setDescription
(String value) The description of the version.void
setIdleSessionTtlInSeconds
(Number value) The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.void
The name of the bot locale.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.void
Specifies configuration settings for the alias used to test the bot.void
Specifies configuration settings for the alias used to test the bot.void
setTestBotAliasTags
(List<Object> value) A list of tags to add to the test alias for a bot.void
setTestBotAliasTags
(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, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods 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:
inspect
in 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:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the bot. -
getAttrId
The unique identifier of the bot. -
getCfnProperties
- Overrides:
getCfnProperties
in 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. -
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. -
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. -
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. -
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. -
getTestBotAliasSettings
Specifies configuration settings for the alias used to test the bot. -
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. -
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.
-