software.amazon.awscdk.services.lex

Interface CfnBot.IntentConfirmationSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.IntentConfirmationSettingProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(value=Stable)
public static interface CfnBot.IntentConfirmationSettingProperty
extends software.amazon.jsii.JsiiSerializable

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

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.*;
 IntentConfirmationSettingProperty intentConfirmationSettingProperty = 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnBot.IntentConfirmationSettingProperty.Builder A builder for CfnBot.IntentConfirmationSettingProperty
static class	CfnBot.IntentConfirmationSettingProperty.Jsii$Proxy An implementation for CfnBot.IntentConfirmationSettingProperty

Method Summary

Modifier and Type	Method and Description
static CfnBot.IntentConfirmationSettingProperty.Builder	builder()
Object	getDeclinationResponse() When the user answers "no" to the question defined in PromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.
default Object	getIsActive() Specifies whether the intent's confirmation is sent to the user.
Object	getPromptSpecification() Prompts the user to confirm the intent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeclinationResponse

@Stability(value=Stable)
 @NotNull
Object getDeclinationResponse()

When the user answers "no" to the question defined in PromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

getPromptSpecification

@Stability(value=Stable)
 @NotNull
Object getPromptSpecification()

Prompts the user to confirm the intent.

This question should have a yes or no answer.

getIsActive

@Stability(value=Stable)
 @Nullable
default Object getIsActive()

Specifies whether the intent's confirmation is sent to the user.

When this field is false, confirmation and declination responses aren't sent and processing continues as if the responses aren't present. If the active field isn't specified, the default is true.

builder

@Stability(value=Stable)
static CfnBot.IntentConfirmationSettingProperty.Builder builder()

Returns:

a CfnBot.IntentConfirmationSettingProperty.Builder of CfnBot.IntentConfirmationSettingProperty