@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:40.538Z") @Stability(value=Stable) public class CfnBot extends CfnResource implements IInspectable
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:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lex.*;
Object dataPrivacy;
Object sentimentAnalysisSettings;
CfnBot cfnBot = CfnBot.Builder.create(this, "MyCfnBot")
.dataPrivacy(dataPrivacy)
.idleSessionTtlInSeconds(123)
.name("name")
.roleArn("roleArn")
// the properties below are optional
.autoBuildBotLocales(false)
.botFileS3Location(S3LocationProperty.builder()
.s3Bucket("s3Bucket")
.s3ObjectKey("s3ObjectKey")
// the properties below are optional
.s3ObjectVersion("s3ObjectVersion")
.build())
.botLocales(List.of(BotLocaleProperty.builder()
.localeId("localeId")
.nluConfidenceThreshold(123)
// the properties below are optional
.customVocabulary(CustomVocabularyProperty.builder()
.customVocabularyItems(List.of(CustomVocabularyItemProperty.builder()
.phrase("phrase")
// the properties below are optional
.weight(123)
.build()))
.build())
.description("description")
.intents(List.of(IntentProperty.builder()
.name("name")
// the properties below are optional
.description("description")
.dialogCodeHook(DialogCodeHookSettingProperty.builder()
.enabled(false)
.build())
.fulfillmentCodeHook(FulfillmentCodeHookSettingProperty.builder()
.enabled(false)
// the properties below are optional
.fulfillmentUpdatesSpecification(FulfillmentUpdatesSpecificationProperty.builder()
.active(false)
// the properties below are optional
.startResponse(FulfillmentStartResponseSpecificationProperty.builder()
.delayInSeconds(123)
.messageGroups(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.timeoutInSeconds(123)
.updateResponse(FulfillmentUpdateResponseSpecificationProperty.builder()
.frequencyInSeconds(123)
.messageGroups(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.build())
.postFulfillmentStatusSpecification(PostFulfillmentStatusSpecificationProperty.builder()
.failureResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.successResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.timeoutResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.build())
.build())
.inputContexts(List.of(InputContextProperty.builder()
.name("name")
.build()))
.intentClosingSetting(IntentClosingSettingProperty.builder()
.closingResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
// the properties below are optional
.isActive(false)
.build())
.intentConfirmationSetting(IntentConfirmationSettingProperty.builder()
.declinationResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.promptSpecification(PromptSpecificationProperty.builder()
.maxRetries(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.messageSelectionStrategy("messageSelectionStrategy")
.build())
// the properties below are optional
.isActive(false)
.build())
.kendraConfiguration(KendraConfigurationProperty.builder()
.kendraIndex("kendraIndex")
// the properties below are optional
.queryFilterString("queryFilterString")
.queryFilterStringEnabled(false)
.build())
.outputContexts(List.of(OutputContextProperty.builder()
.name("name")
.timeToLiveInSeconds(123)
.turnsToLive(123)
.build()))
.parentIntentSignature("parentIntentSignature")
.sampleUtterances(List.of(SampleUtteranceProperty.builder()
.utterance("utterance")
.build()))
.slotPriorities(List.of(SlotPriorityProperty.builder()
.priority(123)
.slotName("slotName")
.build()))
.slots(List.of(SlotProperty.builder()
.name("name")
.slotTypeName("slotTypeName")
.valueElicitationSetting(SlotValueElicitationSettingProperty.builder()
.slotConstraint("slotConstraint")
// the properties below are optional
.defaultValueSpecification(SlotDefaultValueSpecificationProperty.builder()
.defaultValueList(List.of(SlotDefaultValueProperty.builder()
.defaultValue("defaultValue")
.build()))
.build())
.promptSpecification(PromptSpecificationProperty.builder()
.maxRetries(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.messageSelectionStrategy("messageSelectionStrategy")
.build())
.sampleUtterances(List.of(SampleUtteranceProperty.builder()
.utterance("utterance")
.build()))
.waitAndContinueSpecification(WaitAndContinueSpecificationProperty.builder()
.continueResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.waitingResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
// the properties below are optional
.isActive(false)
.stillWaitingResponse(StillWaitingResponseSpecificationProperty.builder()
.frequencyInSeconds(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
.timeoutInSeconds(123)
// the properties below are optional
.allowInterrupt(false)
.build())
.build())
.build())
// the properties below are optional
.description("description")
.multipleValuesSetting(MultipleValuesSettingProperty.builder()
.allowMultipleValues(false)
.build())
.obfuscationSetting(ObfuscationSettingProperty.builder()
.obfuscationSettingType("obfuscationSettingType")
.build())
.build()))
.build()))
.slotTypes(List.of(SlotTypeProperty.builder()
.name("name")
// the properties below are optional
.description("description")
.externalSourceSetting(ExternalSourceSettingProperty.builder()
.grammarSlotTypeSetting(GrammarSlotTypeSettingProperty.builder()
.source(GrammarSlotTypeSourceProperty.builder()
.s3BucketName("s3BucketName")
.s3ObjectKey("s3ObjectKey")
// the properties below are optional
.kmsKeyArn("kmsKeyArn")
.build())
.build())
.build())
.parentSlotTypeSignature("parentSlotTypeSignature")
.slotTypeValues(List.of(SlotTypeValueProperty.builder()
.sampleValue(SampleValueProperty.builder()
.value("value")
.build())
// the properties below are optional
.synonyms(List.of(SampleValueProperty.builder()
.value("value")
.build()))
.build()))
.valueSelectionSetting(SlotValueSelectionSettingProperty.builder()
.resolutionStrategy("resolutionStrategy")
// the properties below are optional
.advancedRecognitionSetting(AdvancedRecognitionSettingProperty.builder()
.audioRecognitionStrategy("audioRecognitionStrategy")
.build())
.regexFilter(SlotValueRegexFilterProperty.builder()
.pattern("pattern")
.build())
.build())
.build()))
.voiceSettings(VoiceSettingsProperty.builder()
.voiceId("voiceId")
// the properties below are optional
.engine("engine")
.build())
.build()))
.botTags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.description("description")
.testBotAliasSettings(TestBotAliasSettingsProperty.builder()
.botAliasLocaleSettings(List.of(BotAliasLocaleSettingsItemProperty.builder()
.botAliasLocaleSetting(BotAliasLocaleSettingsProperty.builder()
.enabled(false)
// the properties below are optional
.codeHookSpecification(CodeHookSpecificationProperty.builder()
.lambdaCodeHook(LambdaCodeHookProperty.builder()
.codeHookInterfaceVersion("codeHookInterfaceVersion")
.lambdaArn("lambdaArn")
.build())
.build())
.build())
.localeId("localeId")
.build()))
.conversationLogSettings(ConversationLogSettingsProperty.builder()
.audioLogSettings(List.of(AudioLogSettingProperty.builder()
.destination(AudioLogDestinationProperty.builder()
.s3Bucket(S3BucketLogDestinationProperty.builder()
.logPrefix("logPrefix")
.s3BucketArn("s3BucketArn")
// the properties below are optional
.kmsKeyArn("kmsKeyArn")
.build())
.build())
.enabled(false)
.build()))
.textLogSettings(List.of(TextLogSettingProperty.builder()
.destination(TextLogDestinationProperty.builder()
.cloudWatch(CloudWatchLogGroupLogDestinationProperty.builder()
.cloudWatchLogGroupArn("cloudWatchLogGroupArn")
.logPrefix("logPrefix")
.build())
.build())
.enabled(false)
.build()))
.build())
.description("description")
.sentimentAnalysisSettings(sentimentAnalysisSettings)
.build())
.testBotAliasTags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnBot.AdvancedRecognitionSettingProperty
Specifies settings that enable advanced audio recognition for slot values.
|
static interface |
CfnBot.AudioLogDestinationProperty
Specifies the location of audio log files collected when conversation logging is enabled for a bot.
|
static interface |
CfnBot.AudioLogSettingProperty
Specifies settings for logging the audio of conversations between Amazon Lex and a user.
|
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 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
Specifies the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
|
static interface |
CfnBot.CodeHookSpecificationProperty
Specifies information about code hooks that Amazon Lex calls during a conversation.
|
static interface |
CfnBot.ConversationLogSettingsProperty
Specifies settings that manage 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.DialogCodeHookSettingProperty
Specifies whether an intent uses the dialog code hook during conversations with a user.
|
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 information for updating the user on the progress of fulfilling an intent.
|
static interface |
CfnBot.FulfillmentUpdatesSpecificationProperty
Provides information for updating the user on the progress of fulfilling an intent.
|
static interface |
CfnBot.GrammarSlotTypeSettingProperty
Settings required 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 of the slot type.
|
static interface |
CfnBot.ImageResponseCardProperty
A card that is shown to the user by a messaging platform.
|
static interface |
CfnBot.InputContextProperty
The name of 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.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 it's 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.PostFulfillmentStatusSpecificationProperty
Provides a setting that determines whether the post-fulfillment response is sent to the user.
|
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 to 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 and intent or responds to a slot elicitation prompt.
|
static interface |
CfnBot.SampleValueProperty
Defines one of the values for a slot type.
|
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
Defines a list of values that Amazon Lex should use as the default value for a slot.
|
static interface |
CfnBot.SlotPriorityProperty
Sets the priority that Amazon Lex should use when eliciting slots 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
Settings that you can use for eliciting a slot value.
|
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.TextLogDestinationProperty
Specifies the Amazon CloudWatch Logs destination log group for conversation text logs.
|
static interface |
CfnBot.TextLogSettingProperty
Specifies settings to enable conversation logs.
|
static interface |
CfnBot.VoiceSettingsProperty
Identifies the Amazon Polly voice used for audio interaction with the user.
|
static interface |
CfnBot.WaitAndContinueSpecificationProperty
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnBot(software.constructs.Construct scope,
String id,
CfnBotProps props)
Create a new `AWS::Lex::Bot`.
|
protected |
CfnBot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnBot(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and 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()
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
|
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 field to filter the list of bots.
|
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(CfnBot.S3LocationProperty value)
The Amazon S3 location of files used to import a bot.
|
void |
setBotFileS3Location(IResolvable value)
The Amazon S3 location of files used to import a bot.
|
void |
setBotLocales(IResolvable value)
A list of locales for the bot.
|
void |
setBotLocales(List<Object> value)
A list of locales for the bot.
|
void |
setBotTags(IResolvable value)
A list of tags to add to the bot.
|
void |
setBotTags(List<Object> value)
A list of tags to add to the bot.
|
void |
setDataPrivacy(Object value)
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
|
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 field to filter the list of bots.
|
void |
setRoleArn(String value)
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
|
void |
setTestBotAliasSettings(CfnBot.TestBotAliasSettingsProperty value)
Specifies configuration settings for the alias used to test the bot.
|
void |
setTestBotAliasSettings(IResolvable value)
Specifies configuration settings for the alias used to test the bot.
|
void |
setTestBotAliasTags(IResolvable value)
A list of tags to add to the test alias for a bot.
|
void |
setTestBotAliasTags(List<Object> value)
A list of tags to add to the test alias for a bot.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnBot(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnBot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnBot(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnBotProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrId()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public Object getDataPrivacy()
@Stability(value=Stable)
public void setDataPrivacy(@NotNull
Object value)
@Stability(value=Stable) @NotNull public Number getIdleSessionTtlInSeconds()
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.
@Stability(value=Stable)
public void setIdleSessionTtlInSeconds(@NotNull
Number value)
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.
@Stability(value=Stable) @NotNull public String getName()
@Stability(value=Stable)
public void setName(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getRoleArn()
@Stability(value=Stable)
public void setRoleArn(@NotNull
String value)
@Stability(value=Stable) @Nullable public Object getAutoBuildBotLocales()
@Stability(value=Stable)
public void setAutoBuildBotLocales(@Nullable
Boolean value)
@Stability(value=Stable)
public void setAutoBuildBotLocales(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getBotFileS3Location()
The files must be in the import format specified in JSON format for importing and exporting in the Amazon Lex developer guide.
@Stability(value=Stable)
public void setBotFileS3Location(@Nullable
CfnBot.S3LocationProperty value)
The files must be in the import format specified in JSON format for importing and exporting in the Amazon Lex developer guide.
@Stability(value=Stable)
public void setBotFileS3Location(@Nullable
IResolvable value)
The files must be in the import format specified in JSON format for importing and exporting in the Amazon Lex developer guide.
@Stability(value=Stable) @Nullable public Object getBotLocales()
@Stability(value=Stable)
public void setBotLocales(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setBotLocales(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public Object getBotTags()
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.
@Stability(value=Stable)
public void setBotTags(@Nullable
IResolvable value)
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.
@Stability(value=Stable)
public void setBotTags(@Nullable
List<Object> value)
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.
@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getTestBotAliasSettings()
If the TestBotAliasSettings property is not specified, the settings are configured with default values.
@Stability(value=Stable)
public void setTestBotAliasSettings(@Nullable
CfnBot.TestBotAliasSettingsProperty value)
If the TestBotAliasSettings property is not specified, the settings are configured with default values.
@Stability(value=Stable)
public void setTestBotAliasSettings(@Nullable
IResolvable value)
If the TestBotAliasSettings property is not specified, the settings are configured with default values.
@Stability(value=Stable) @Nullable public Object getTestBotAliasTags()
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.
@Stability(value=Stable)
public void setTestBotAliasTags(@Nullable
IResolvable value)
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.
@Stability(value=Stable)
public void setTestBotAliasTags(@Nullable
List<Object> value)
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.
Copyright © 2022. All rights reserved.