Class CfnBot.IntentConfirmationSettingProperty.Builder
java.lang.Object
software.amazon.awscdk.services.lex.CfnBot.IntentConfirmationSettingProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnBot.IntentConfirmationSettingProperty>
- Enclosing interface:
CfnBot.IntentConfirmationSettingProperty
@Stability(Stable)
public static final class CfnBot.IntentConfirmationSettingProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBot.IntentConfirmationSettingProperty>
A builder for
CfnBot.IntentConfirmationSettingProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.codeHook
(IResolvable codeHook) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getCodeHook()
Sets the value ofCfnBot.IntentConfirmationSettingProperty.getCodeHook()
confirmationConditional
(IResolvable confirmationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationConditional()
confirmationConditional
(CfnBot.ConditionalSpecificationProperty confirmationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationConditional()
confirmationNextStep
(IResolvable confirmationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationNextStep()
confirmationNextStep
(CfnBot.DialogStateProperty confirmationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationNextStep()
confirmationResponse
(IResolvable confirmationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationResponse()
confirmationResponse
(CfnBot.ResponseSpecificationProperty confirmationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationResponse()
declinationConditional
(IResolvable declinationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationConditional()
declinationConditional
(CfnBot.ConditionalSpecificationProperty declinationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationConditional()
declinationNextStep
(IResolvable declinationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationNextStep()
declinationNextStep
(CfnBot.DialogStateProperty declinationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationNextStep()
declinationResponse
(IResolvable declinationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationResponse()
declinationResponse
(CfnBot.ResponseSpecificationProperty declinationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationResponse()
elicitationCodeHook
(IResolvable elicitationCodeHook) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getElicitationCodeHook()
elicitationCodeHook
(CfnBot.ElicitationCodeHookInvocationSettingProperty elicitationCodeHook) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getElicitationCodeHook()
failureConditional
(IResolvable failureConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureConditional()
failureConditional
(CfnBot.ConditionalSpecificationProperty failureConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureConditional()
failureNextStep
(IResolvable failureNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureNextStep()
failureNextStep
(CfnBot.DialogStateProperty failureNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureNextStep()
failureResponse
(IResolvable failureResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureResponse()
failureResponse
(CfnBot.ResponseSpecificationProperty failureResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureResponse()
Sets the value ofCfnBot.IntentConfirmationSettingProperty.getIsActive()
isActive
(IResolvable isActive) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getIsActive()
promptSpecification
(IResolvable promptSpecification) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getPromptSpecification()
promptSpecification
(CfnBot.PromptSpecificationProperty promptSpecification) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getPromptSpecification()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
promptSpecification
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder promptSpecification(IResolvable promptSpecification) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getPromptSpecification()
- Parameters:
promptSpecification
- Prompts the user to confirm the intent. This question should have a yes or no answer. This parameter is required. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with theOrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.- Returns:
this
-
promptSpecification
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder promptSpecification(CfnBot.PromptSpecificationProperty promptSpecification) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getPromptSpecification()
- Parameters:
promptSpecification
- Prompts the user to confirm the intent. This question should have a yes or no answer. This parameter is required. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with theOrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.- Returns:
this
-
codeHook
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder codeHook(IResolvable codeHook) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getCodeHook()
- Parameters:
codeHook
- TheDialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
.- Returns:
this
-
codeHook
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder codeHook(CfnBot.DialogCodeHookInvocationSettingProperty codeHook) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getCodeHook()
- Parameters:
codeHook
- TheDialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
.- Returns:
this
-
confirmationConditional
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder confirmationConditional(IResolvable confirmationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationConditional()
- Parameters:
confirmationConditional
- A list of conditional branches to evaluate after the intent is closed.- Returns:
this
-
confirmationConditional
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder confirmationConditional(CfnBot.ConditionalSpecificationProperty confirmationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationConditional()
- Parameters:
confirmationConditional
- A list of conditional branches to evaluate after the intent is closed.- Returns:
this
-
confirmationNextStep
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder confirmationNextStep(IResolvable confirmationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationNextStep()
- Parameters:
confirmationNextStep
- Specifies the next step that the bot executes when the customer confirms the intent.- Returns:
this
-
confirmationNextStep
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder confirmationNextStep(CfnBot.DialogStateProperty confirmationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationNextStep()
- Parameters:
confirmationNextStep
- Specifies the next step that the bot executes when the customer confirms the intent.- Returns:
this
-
confirmationResponse
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder confirmationResponse(IResolvable confirmationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationResponse()
- Parameters:
confirmationResponse
- Specifies a list of message groups that Amazon Lex uses to respond the user input.- Returns:
this
-
confirmationResponse
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder confirmationResponse(CfnBot.ResponseSpecificationProperty confirmationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getConfirmationResponse()
- Parameters:
confirmationResponse
- Specifies a list of message groups that Amazon Lex uses to respond the user input.- Returns:
this
-
declinationConditional
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder declinationConditional(IResolvable declinationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationConditional()
- Parameters:
declinationConditional
- A list of conditional branches to evaluate after the intent is declined.- Returns:
this
-
declinationConditional
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder declinationConditional(CfnBot.ConditionalSpecificationProperty declinationConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationConditional()
- Parameters:
declinationConditional
- A list of conditional branches to evaluate after the intent is declined.- Returns:
this
-
declinationNextStep
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder declinationNextStep(IResolvable declinationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationNextStep()
- Parameters:
declinationNextStep
- Specifies the next step that the bot executes when the customer declines the intent.- Returns:
this
-
declinationNextStep
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder declinationNextStep(CfnBot.DialogStateProperty declinationNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationNextStep()
- Parameters:
declinationNextStep
- Specifies the next step that the bot executes when the customer declines the intent.- Returns:
this
-
declinationResponse
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder declinationResponse(IResolvable declinationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationResponse()
- Parameters:
declinationResponse
- When the user answers "no" to the question defined inpromptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.- Returns:
this
-
declinationResponse
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder declinationResponse(CfnBot.ResponseSpecificationProperty declinationResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getDeclinationResponse()
- Parameters:
declinationResponse
- When the user answers "no" to the question defined inpromptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.- Returns:
this
-
elicitationCodeHook
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder elicitationCodeHook(IResolvable elicitationCodeHook) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getElicitationCodeHook()
- Parameters:
elicitationCodeHook
- TheDialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.- Returns:
this
-
elicitationCodeHook
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder elicitationCodeHook(CfnBot.ElicitationCodeHookInvocationSettingProperty elicitationCodeHook) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getElicitationCodeHook()
- Parameters:
elicitationCodeHook
- TheDialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.- Returns:
this
-
failureConditional
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder failureConditional(IResolvable failureConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureConditional()
- Parameters:
failureConditional
- Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.- Returns:
this
-
failureConditional
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder failureConditional(CfnBot.ConditionalSpecificationProperty failureConditional) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureConditional()
- Parameters:
failureConditional
- Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.- Returns:
this
-
failureNextStep
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder failureNextStep(IResolvable failureNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureNextStep()
- Parameters:
failureNextStep
- The next step to take in the conversation if the confirmation step fails.- Returns:
this
-
failureNextStep
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder failureNextStep(CfnBot.DialogStateProperty failureNextStep) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureNextStep()
- Parameters:
failureNextStep
- The next step to take in the conversation if the confirmation step fails.- Returns:
this
-
failureResponse
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder failureResponse(IResolvable failureResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureResponse()
- Parameters:
failureResponse
- Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails.- Returns:
this
-
failureResponse
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder failureResponse(CfnBot.ResponseSpecificationProperty failureResponse) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getFailureResponse()
- Parameters:
failureResponse
- Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails.- Returns:
this
-
isActive
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder isActive(Boolean isActive) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getIsActive()
- Parameters:
isActive
- Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If theIsActive
field isn't specified, the default is true.- Returns:
this
-
isActive
@Stability(Stable) public CfnBot.IntentConfirmationSettingProperty.Builder isActive(IResolvable isActive) Sets the value ofCfnBot.IntentConfirmationSettingProperty.getIsActive()
- Parameters:
isActive
- Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If theIsActive
field isn't specified, the default is true.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnBot.IntentConfirmationSettingProperty>
- Returns:
- a new instance of
CfnBot.IntentConfirmationSettingProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-