Package software.amazon.awscdk.cfnpropertymixins.services.lex

Class CfnBotPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.lex.CfnBotPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.964Z")
@Stability(Stable)
public class CfnBotPropsMixin
extends Mixin
implements software.constructs.IMixin

Amazon Lex V2 is the only supported version in 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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnBotPropsMixin.AdvancedRecognitionSettingProperty	Provides settings that enable advanced recognition settings for slot values.
static interface	CfnBotPropsMixin.AllowedInputTypesProperty	Specifies the allowed input types.
static interface	CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty	Specifies the audio and DTMF input specification.
static interface	CfnBotPropsMixin.AudioLogDestinationProperty	The location of audio log files collected when conversation logging is enabled for a bot.
static interface	CfnBotPropsMixin.AudioLogSettingProperty	Settings for logging audio of conversations between Amazon Lex and a user.
static interface	CfnBotPropsMixin.AudioSpecificationProperty	Specifies the audio input specifications.
static interface	CfnBotPropsMixin.BedrockAgentConfigurationProperty	Example:
static interface	CfnBotPropsMixin.BedrockAgentIntentConfigurationProperty	Example:
static interface	CfnBotPropsMixin.BedrockAgentIntentKnowledgeBaseConfigurationProperty	Example:
static interface	CfnBotPropsMixin.BedrockGuardrailConfigurationProperty	The details on the Bedrock guardrail configuration.
static interface	CfnBotPropsMixin.BedrockKnowledgeStoreConfigurationProperty	Contains details about the configuration of a Amazon Bedrock knowledge base.
static interface	CfnBotPropsMixin.BedrockModelSpecificationProperty	Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
static interface	CfnBotPropsMixin.BKBExactResponseFieldsProperty	Example:
static interface	CfnBotPropsMixin.BotAliasLocaleSettingsItemProperty	Specifies locale settings for a single locale.
static interface	CfnBotPropsMixin.BotAliasLocaleSettingsProperty	Specifies settings that are unique to a locale.
static interface	CfnBotPropsMixin.BotLocaleProperty	Provides configuration information for a locale.
static final class	CfnBotPropsMixin.Builder	A fluent builder for CfnBotPropsMixin.
static interface	CfnBotPropsMixin.BuildtimeSettingsProperty	Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
static interface	CfnBotPropsMixin.ButtonProperty	Describes a button to use on a response card used to gather slot values from a user.
static interface	CfnBotPropsMixin.CloudWatchLogGroupLogDestinationProperty	The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.
static interface	CfnBotPropsMixin.CodeHookSpecificationProperty	Contains information about code hooks that Amazon Lex calls during a conversation.
static interface	CfnBotPropsMixin.CompositeSlotTypeSettingProperty	A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.
static interface	CfnBotPropsMixin.ConditionalBranchProperty	A set of actions that Amazon Lex should run if the condition is matched.
static interface	CfnBotPropsMixin.ConditionalSpecificationProperty	Provides a list of conditional branches.
static interface	CfnBotPropsMixin.ConditionProperty	Provides an expression that evaluates to true or false.
static interface	CfnBotPropsMixin.ConversationLogSettingsProperty	Configures conversation logging that saves audio, text, and metadata for the conversations with your users.
static interface	CfnBotPropsMixin.CustomPayloadProperty	A custom response string that Amazon Lex sends to your application.
static interface	CfnBotPropsMixin.CustomVocabularyItemProperty	Specifies an entry in a custom vocabulary.
static interface	CfnBotPropsMixin.CustomVocabularyProperty	Specifies a custom vocabulary.
static interface	CfnBotPropsMixin.DataPrivacyProperty	By default, data stored by Amazon Lex is encrypted.
static interface	CfnBotPropsMixin.DataSourceConfigurationProperty	Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent .
static interface	CfnBotPropsMixin.DeepgramSpeechModelConfigProperty	Example:
static interface	CfnBotPropsMixin.DefaultConditionalBranchProperty	A set of actions that Amazon Lex should run if none of the other conditions are met.
static interface	CfnBotPropsMixin.DescriptiveBotBuilderSpecificationProperty	Contains specifications for the descriptive bot building feature.
static interface	CfnBotPropsMixin.DialogActionProperty	Defines the action that the bot executes at runtime when the conversation reaches this step.
static interface	CfnBotPropsMixin.DialogCodeHookInvocationSettingProperty	Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
static interface	CfnBotPropsMixin.DialogCodeHookSettingProperty	Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
static interface	CfnBotPropsMixin.DialogStateProperty	The current state of the conversation with the user.
static interface	CfnBotPropsMixin.DTMFSpecificationProperty	Specifies the DTMF input specifications.
static interface	CfnBotPropsMixin.ElicitationCodeHookInvocationSettingProperty	Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.
static interface	CfnBotPropsMixin.ErrorLogSettingsProperty	Example:
static interface	CfnBotPropsMixin.ExactResponseFieldsProperty	Contains the names of the fields used for an exact response to the user.
static interface	CfnBotPropsMixin.ExternalSourceSettingProperty	Provides information about the external source of the slot type's definition.
static interface	CfnBotPropsMixin.FulfillmentCodeHookSettingProperty	Determines if a Lambda function should be invoked for a specific intent.
static interface	CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty	Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.
static interface	CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty	Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.
static interface	CfnBotPropsMixin.FulfillmentUpdatesSpecificationProperty	Provides information for updating the user on the progress of fulfilling an intent.
static interface	CfnBotPropsMixin.GenerativeAISettingsProperty	Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
static interface	CfnBotPropsMixin.GrammarSlotTypeSettingProperty	Settings requried for a slot type based on a grammar that you provide.
static interface	CfnBotPropsMixin.GrammarSlotTypeSourceProperty	Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.
static interface	CfnBotPropsMixin.ImageResponseCardProperty	A card that is shown to the user by a messaging platform.
static interface	CfnBotPropsMixin.InitialResponseSettingProperty	Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
static interface	CfnBotPropsMixin.InputContextProperty	A context that must be active for an intent to be selected by Amazon Lex.
static interface	CfnBotPropsMixin.IntentClosingSettingProperty	Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
static interface	CfnBotPropsMixin.IntentConfirmationSettingProperty	Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
static interface	CfnBotPropsMixin.IntentDisambiguationSettingsProperty	Configures the Intent Disambiguation feature that helps resolve ambiguous user inputs when multiple intents could match.
static interface	CfnBotPropsMixin.IntentOverrideProperty	Override settings to configure the intent state.
static interface	CfnBotPropsMixin.IntentProperty	Represents an action that the user wants to perform.
static interface	CfnBotPropsMixin.KendraConfigurationProperty	Provides configuration information for the AMAZON.KendraSearchIntent intent.
static interface	CfnBotPropsMixin.LambdaCodeHookProperty	Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
static interface	CfnBotPropsMixin.MessageGroupProperty	Provides one or more messages that Amazon Lex should send to the user.
static interface	CfnBotPropsMixin.MessageProperty	The object that provides message text and its type.
static interface	CfnBotPropsMixin.MultipleValuesSettingProperty	Indicates whether a slot can return multiple values.
static interface	CfnBotPropsMixin.NluImprovementSpecificationProperty	Configures the Assisted Natural Language Understanding (NLU) feature for your bot.
static interface	CfnBotPropsMixin.ObfuscationSettingProperty	Determines whether Amazon Lex obscures slot values in conversation logs.
static interface	CfnBotPropsMixin.OpensearchConfigurationProperty	Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent .
static interface	CfnBotPropsMixin.OutputContextProperty	Describes a session context that is activated when an intent is fulfilled.
static interface	CfnBotPropsMixin.PlainTextMessageProperty	Defines an ASCII text message to send to the user.
static interface	CfnBotPropsMixin.PostDialogCodeHookInvocationSpecificationProperty	Specifies next steps to run after the dialog code hook finishes.
static interface	CfnBotPropsMixin.PostFulfillmentStatusSpecificationProperty	Provides a setting that determines whether the post-fulfillment response is sent to the user.
static interface	CfnBotPropsMixin.PromptAttemptSpecificationProperty	Specifies the settings on a prompt attempt.
static interface	CfnBotPropsMixin.PromptSpecificationProperty	Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
static interface	CfnBotPropsMixin.QInConnectAssistantConfigurationProperty	Example:
static interface	CfnBotPropsMixin.QInConnectIntentConfigurationProperty	Example:
static interface	CfnBotPropsMixin.QnAIntentConfigurationProperty	Details about the the configuration of the built-in Amazon.QnAIntent .
static interface	CfnBotPropsMixin.QnAKendraConfigurationProperty	Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent .
static interface	CfnBotPropsMixin.ReplicationProperty	Example:
static interface	CfnBotPropsMixin.ResponseSpecificationProperty	Specifies a list of message groups that Amazon Lex uses to respond the user input.
static interface	CfnBotPropsMixin.RuntimeSettingsProperty	Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
static interface	CfnBotPropsMixin.S3BucketLogDestinationProperty	Specifies an Amazon S3 bucket for logging audio conversations.
static interface	CfnBotPropsMixin.S3LocationProperty	Defines an Amazon S3 bucket location.
static interface	CfnBotPropsMixin.SampleUtteranceGenerationSpecificationProperty	Contains specifications for the sample utterance generation feature.
static interface	CfnBotPropsMixin.SampleUtteranceProperty	A sample utterance that invokes an intent or respond to a slot elicitation prompt.
static interface	CfnBotPropsMixin.SampleValueProperty	Defines one of the values for a slot type.
static interface	CfnBotPropsMixin.SessionAttributeProperty	A key/value pair representing session-specific context information.
static interface	CfnBotPropsMixin.SlotCaptureSettingProperty	Settings used when Amazon Lex successfully captures a slot value from a user.
static interface	CfnBotPropsMixin.SlotDefaultValueProperty	Specifies the default value to use when a user doesn't provide a value for a slot.
static interface	CfnBotPropsMixin.SlotDefaultValueSpecificationProperty	The default value to use when a user doesn't provide a value for a slot.
static interface	CfnBotPropsMixin.SlotPriorityProperty	Sets the priority that Amazon Lex should use when eliciting slot values from a user.
static interface	CfnBotPropsMixin.SlotProperty	Specifies the definition of a slot.
static interface	CfnBotPropsMixin.SlotResolutionImprovementSpecificationProperty	Contains specifications for the assisted slot resolution feature.
static interface	CfnBotPropsMixin.SlotTypeProperty	Describes a slot type.
static interface	CfnBotPropsMixin.SlotTypeValueProperty	Each slot type can have a set of values.
static interface	CfnBotPropsMixin.SlotValueElicitationSettingProperty	Specifies the elicitation setting details eliciting a slot.
static interface	CfnBotPropsMixin.SlotValueOverrideMapProperty	Maps a slot name to the SlotValueOverride object.
static interface	CfnBotPropsMixin.SlotValueOverrideProperty	The slot values that Amazon Lex uses when it sets slot values in a dialog step.
static interface	CfnBotPropsMixin.SlotValueProperty	The value to set in a slot.
static interface	CfnBotPropsMixin.SlotValueRegexFilterProperty	Provides a regular expression used to validate the value of a slot.
static interface	CfnBotPropsMixin.SlotValueSelectionSettingProperty	Contains settings used by Amazon Lex to select a slot value.
static interface	CfnBotPropsMixin.SpecificationsProperty	Subslot specifications.
static interface	CfnBotPropsMixin.SpeechFoundationModelProperty	Configuration for a foundation model used for speech synthesis and recognition capabilities.
static interface	CfnBotPropsMixin.SpeechModelConfigProperty	Example:
static interface	CfnBotPropsMixin.SpeechRecognitionSettingsProperty	Example:
static interface	CfnBotPropsMixin.SSMLMessageProperty	Defines a Speech Synthesis Markup Language (SSML) prompt.
static interface	CfnBotPropsMixin.StillWaitingResponseSpecificationProperty	Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.
static interface	CfnBotPropsMixin.SubSlotSettingProperty	Specifications for the constituent sub slots and the expression for the composite slot.
static interface	CfnBotPropsMixin.SubSlotTypeCompositionProperty	Subslot type composition.
static interface	CfnBotPropsMixin.SubSlotValueElicitationSettingProperty	Subslot elicitation settings.
static interface	CfnBotPropsMixin.TestBotAliasSettingsProperty	Specifies configuration settings for the alias used to test the bot.
static interface	CfnBotPropsMixin.TextInputSpecificationProperty	Specifies the text input specifications.
static interface	CfnBotPropsMixin.TextLogDestinationProperty	Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
static interface	CfnBotPropsMixin.TextLogSettingProperty	Defines settings to enable text conversation logs.
static interface	CfnBotPropsMixin.UnifiedSpeechSettingsProperty	Unified configuration settings that combine speech recognition and synthesis capabilities.
static interface	CfnBotPropsMixin.VoiceSettingsProperty	Defines settings for using an Amazon Polly voice to communicate with a user.
static interface	CfnBotPropsMixin.WaitAndContinueSpecificationProperty	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.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnBotPropsMixin(CfnBotMixinProps props)	Create a mixin to apply properties to AWS::Lex::Bot.
	CfnBotPropsMixin(CfnBotMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Lex::Bot.
protected	CfnBotPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBotPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnBotMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnBotPropsMixin

protected CfnBotPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnBotPropsMixin

protected CfnBotPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBotPropsMixin

@Stability(Stable)
public CfnBotPropsMixin(@NotNull
 CfnBotMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Lex::Bot.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnBotPropsMixin

@Stability(Stable)
public CfnBotPropsMixin(@NotNull
 CfnBotMixinProps props)

Create a mixin to apply properties to AWS::Lex::Bot.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnBotMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()