Package software.amazon.awscdk.services.lex

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-11-21T06:34:10.566Z")
@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:

• 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	CfnBot.AdvancedRecognitionSettingProperty	Provides settings that enable advanced recognition settings for slot values.
static interface	CfnBot.AllowedInputTypesProperty	Specifies the allowed input types.
static interface	CfnBot.AudioAndDTMFInputSpecificationProperty	Specifies the audio and DTMF input specification.
static interface	CfnBot.AudioLogDestinationProperty	The location of audio log files collected when conversation logging is enabled for a bot.
static interface	CfnBot.AudioLogSettingProperty	Settings for logging audio of conversations between Amazon Lex and a user.
static interface	CfnBot.AudioSpecificationProperty	Specifies the audio input specifications.
static interface	CfnBot.BotAliasLocaleSettingsItemProperty	Specifies locale settings for a single locale.
static interface	CfnBot.BotAliasLocaleSettingsProperty	Specifies settings that are unique to a locale.
static interface	CfnBot.BotLocaleProperty	Provides configuration information for a locale.
static final class	CfnBot.Builder	A fluent builder for CfnBot.
static interface	CfnBot.ButtonProperty	Describes a button to use on a response card used to gather slot values from a user.
static interface	CfnBot.CloudWatchLogGroupLogDestinationProperty	The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.
static interface	CfnBot.CodeHookSpecificationProperty	Contains information about code hooks that Amazon Lex calls during a conversation.
static interface	CfnBot.ConditionalBranchProperty	A set of actions that Amazon Lex should run if the condition is matched.
static interface	CfnBot.ConditionalSpecificationProperty	Provides a list of conditional branches.
static interface	CfnBot.ConditionProperty	Provides an expression that evaluates to true or false.
static interface	CfnBot.ConversationLogSettingsProperty	Configures conversation logging that saves audio, text, and metadata for the conversations with your users.
static interface	CfnBot.CustomPayloadProperty	A custom response string that Amazon Lex sends to your application.
static interface	CfnBot.CustomVocabularyItemProperty	Specifies an entry in a custom vocabulary.
static interface	CfnBot.CustomVocabularyProperty	Specifies a custom vocabulary.
static interface	CfnBot.DataPrivacyProperty	By default, data stored by Amazon Lex is encrypted.
static interface	CfnBot.DefaultConditionalBranchProperty	A set of actions that Amazon Lex should run if none of the other conditions are met.
static interface	CfnBot.DialogActionProperty	Defines the action that the bot executes at runtime when the conversation reaches this step.
static interface	CfnBot.DialogCodeHookInvocationSettingProperty	Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
static interface	CfnBot.DialogCodeHookSettingProperty	Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
static interface	CfnBot.DialogStateProperty	The current state of the conversation with the user.
static interface	CfnBot.DTMFSpecificationProperty	Specifies the DTMF input specifications.
static interface	CfnBot.ElicitationCodeHookInvocationSettingProperty	Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.
static interface	CfnBot.ExternalSourceSettingProperty	Provides information about the external source of the slot type's definition.
static interface	CfnBot.FulfillmentCodeHookSettingProperty	Determines if a Lambda function should be invoked for a specific intent.
static interface	CfnBot.FulfillmentStartResponseSpecificationProperty	Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.
static interface	CfnBot.FulfillmentUpdateResponseSpecificationProperty	Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.
static interface	CfnBot.FulfillmentUpdatesSpecificationProperty	Provides information for updating the user on the progress of fulfilling an intent.
static interface	CfnBot.GrammarSlotTypeSettingProperty	Settings requried for a slot type based on a grammar that you provide.
static interface	CfnBot.GrammarSlotTypeSourceProperty	Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.
static interface	CfnBot.ImageResponseCardProperty	A card that is shown to the user by a messaging platform.
static interface	CfnBot.InitialResponseSettingProperty	Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
static interface	CfnBot.InputContextProperty	A context that must be active for an intent to be selected by Amazon Lex.
static interface	CfnBot.IntentClosingSettingProperty	Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
static interface	CfnBot.IntentConfirmationSettingProperty	Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
static interface	CfnBot.IntentOverrideProperty	Override settings to configure the intent state.
static interface	CfnBot.IntentProperty	Represents an action that the user wants to perform.
static interface	CfnBot.KendraConfigurationProperty	Provides configuration information for the AMAZON.KendraSearchIntent intent.
static interface	CfnBot.LambdaCodeHookProperty	Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
static interface	CfnBot.MessageGroupProperty	Provides one or more messages that Amazon Lex should send to the user.
static interface	CfnBot.MessageProperty	The object that provides message text and its type.
static interface	CfnBot.MultipleValuesSettingProperty	Indicates whether a slot can return multiple values.
static interface	CfnBot.ObfuscationSettingProperty	Determines whether Amazon Lex obscures slot values in conversation logs.
static interface	CfnBot.OutputContextProperty	Describes a session context that is activated when an intent is fulfilled.
static interface	CfnBot.PlainTextMessageProperty	Defines an ASCII text message to send to the user.
static interface	CfnBot.PostDialogCodeHookInvocationSpecificationProperty	Specifies next steps to run after the dialog code hook finishes.
static interface	CfnBot.PostFulfillmentStatusSpecificationProperty	Provides a setting that determines whether the post-fulfillment response is sent to the user.
static interface	CfnBot.PromptAttemptSpecificationProperty	Specifies the settings on a prompt attempt.
static interface	CfnBot.PromptSpecificationProperty	Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
static interface	CfnBot.ResponseSpecificationProperty	Specifies a list of message groups that Amazon Lex uses to respond the user input.
static interface	CfnBot.S3BucketLogDestinationProperty	Specifies an Amazon S3 bucket for logging audio conversations.
static interface	CfnBot.S3LocationProperty	Defines an Amazon S3 bucket location.
static interface	CfnBot.SampleUtteranceProperty	A sample utterance that invokes an intent or respond to a slot elicitation prompt.
static interface	CfnBot.SampleValueProperty	Defines one of the values for a slot type.
static interface	CfnBot.SentimentAnalysisSettingsProperty	Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
static interface	CfnBot.SessionAttributeProperty	A key/value pair representing session-specific context information.
static interface	CfnBot.SlotCaptureSettingProperty	Settings used when Amazon Lex successfully captures a slot value from a user.
static interface	CfnBot.SlotDefaultValueProperty	Specifies the default value to use when a user doesn't provide a value for a slot.
static interface	CfnBot.SlotDefaultValueSpecificationProperty	The default value to use when a user doesn't provide a value for a slot.
static interface	CfnBot.SlotPriorityProperty	Sets the priority that Amazon Lex should use when eliciting slot values from a user.
static interface	CfnBot.SlotProperty	Specifies the definition of a slot.
static interface	CfnBot.SlotTypeProperty	Describes a slot type.
static interface	CfnBot.SlotTypeValueProperty	Each slot type can have a set of values.
static interface	CfnBot.SlotValueElicitationSettingProperty	Specifies the elicitation setting details eliciting a slot.
static interface	CfnBot.SlotValueOverrideMapProperty	Maps a slot name to the SlotValueOverride object.
static interface	CfnBot.SlotValueOverrideProperty	The slot values that Amazon Lex uses when it sets slot values in a dialog step.
static interface	CfnBot.SlotValueProperty	The value to set in a slot.
static interface	CfnBot.SlotValueRegexFilterProperty	Provides a regular expression used to validate the value of a slot.
static interface	CfnBot.SlotValueSelectionSettingProperty	Contains settings used by Amazon Lex to select a slot value.
static interface	CfnBot.SSMLMessageProperty	Defines a Speech Synthesis Markup Language (SSML) prompt.
static interface	CfnBot.StillWaitingResponseSpecificationProperty	Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.
static interface	CfnBot.TestBotAliasSettingsProperty	Specifies configuration settings for the alias used to test the bot.
static interface	CfnBot.TextInputSpecificationProperty	Specifies the text input specifications.
static interface	CfnBot.TextLogDestinationProperty	Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
static interface	CfnBot.TextLogSettingProperty	Defines settings to enable text conversation logs.
static interface	CfnBot.VoiceSettingsProperty	Defines settings for using an Amazon Polly voice to communicate with a user.
static interface	CfnBot.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	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 Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the bot.
String	getAttrId()	The unique identifier of the bot.
Object	getAutoBuildBotLocales()	Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.
Object	getBotFileS3Location()	The Amazon S3 location of files used to import a bot.
Object	getBotLocales()	A list of locales for the bot.
Object	getBotTags()	A list of tags to add to the bot.
protected Map<String,Object>	getCfnProperties()
Object	getDataPrivacy()	By default, data stored by Amazon Lex is encrypted.
String	getDescription()	The description of the version.
Number	getIdleSessionTtlInSeconds()	The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
String	getName()	The name of the bot locale.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
Object	getTestBotAliasSettings()	Specifies configuration settings for the alias used to test the bot.
Object	getTestBotAliasTags()	A list of tags to add to the test alias for a bot.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	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	setAutoBuildBotLocales(IResolvable value)	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	setBotFileS3Location(CfnBot.S3LocationProperty value)	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	setName(String value)	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	setTestBotAliasSettings(IResolvable value)	Specifies configuration settings for the alias used to test the bot.
void	setTestBotAliasSettings(CfnBot.TestBotAliasSettingsProperty value)	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

@Stability(Stable)
public static final String 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

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

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 class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the bot.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique identifier of the bot.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataPrivacy

@Stability(Stable)
@NotNull
public Object getDataPrivacy()

By default, data stored by Amazon Lex is encrypted.

setDataPrivacy

@Stability(Stable)
public void setDataPrivacy(@NotNull
 Object value)

By default, data stored by Amazon Lex is encrypted.

getIdleSessionTtlInSeconds

@Stability(Stable)
@NotNull
public Number getIdleSessionTtlInSeconds()

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

setIdleSessionTtlInSeconds

@Stability(Stable)
public void setIdleSessionTtlInSeconds(@NotNull
 Number value)

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the bot locale.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the bot locale.

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

getAutoBuildBotLocales

@Stability(Stable)
@Nullable
public Object getAutoBuildBotLocales()

Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.

setAutoBuildBotLocales

@Stability(Stable)
public void setAutoBuildBotLocales(@Nullable
 Boolean value)

Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.

setAutoBuildBotLocales

@Stability(Stable)
public void setAutoBuildBotLocales(@Nullable
 IResolvable value)

Indicates whether Amazon Lex V2 should automatically build the locales for the bot after a change.

getBotFileS3Location

@Stability(Stable)
@Nullable
public Object getBotFileS3Location()

The Amazon S3 location of files used to import a bot.

setBotFileS3Location

@Stability(Stable)
public void setBotFileS3Location(@Nullable
 IResolvable value)

The Amazon S3 location of files used to import a bot.

setBotFileS3Location

@Stability(Stable)
public void setBotFileS3Location(@Nullable
 CfnBot.S3LocationProperty value)

The Amazon S3 location of files used to import a bot.

getBotLocales

@Stability(Stable)
@Nullable
public Object getBotLocales()

A list of locales for the bot.

setBotLocales

@Stability(Stable)
public void setBotLocales(@Nullable
 IResolvable value)

A list of locales for the bot.

setBotLocales

@Stability(Stable)
public void setBotLocales(@Nullable
 List<Object> value)

A list of locales for the bot.

getBotTags

@Stability(Stable)
@Nullable
public Object getBotTags()

A list of tags to add to the bot.

setBotTags

@Stability(Stable)
public void setBotTags(@Nullable
 IResolvable value)

A list of tags to add to the bot.

setBotTags

@Stability(Stable)
public void setBotTags(@Nullable
 List<Object> value)

A list of tags to add to the bot.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the version.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the version.

getTestBotAliasSettings

@Stability(Stable)
@Nullable
public Object getTestBotAliasSettings()

Specifies configuration settings for the alias used to test the bot.

setTestBotAliasSettings

@Stability(Stable)
public void setTestBotAliasSettings(@Nullable
 IResolvable value)

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

@Stability(Stable)
@Nullable
public Object getTestBotAliasTags()

A list of tags to add to the test alias for a bot.

setTestBotAliasTags

@Stability(Stable)
public void setTestBotAliasTags(@Nullable
 IResolvable value)

A list of tags to add to the test alias for a bot.

setTestBotAliasTags

@Stability(Stable)
public void setTestBotAliasTags(@Nullable
 List<Object> value)

A list of tags to add to the test alias for a bot.