Class CfnAgentMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnAgentMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAgentMixinProps>
- Enclosing interface:
CfnAgentMixinProps
@Stability(Stable)
public static final class CfnAgentMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAgentMixinProps>
A builder for
CfnAgentMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactionConnectors(List<String> actionConnectors) Sets the value ofCfnAgentMixinProps.getActionConnectors()Sets the value ofCfnAgentMixinProps.getAgentId()agentLifecycle(String agentLifecycle) Sets the value ofCfnAgentMixinProps.getAgentLifecycle()awsAccountId(String awsAccountId) Sets the value ofCfnAgentMixinProps.getAwsAccountId()build()Builds the configured instance.customPromptInput(CfnAgentPropsMixin.CustomPromptInputProperty customPromptInput) Sets the value ofCfnAgentMixinProps.getCustomPromptInput()customPromptInput(IResolvable customPromptInput) Sets the value ofCfnAgentMixinProps.getCustomPromptInput()description(String description) Sets the value ofCfnAgentMixinProps.getDescription()Sets the value ofCfnAgentMixinProps.getIconId()Sets the value ofCfnAgentMixinProps.getName()Sets the value ofCfnAgentMixinProps.getSpaces()starterPrompts(List<String> starterPrompts) Sets the value ofCfnAgentMixinProps.getStarterPrompts()tags(List<? extends CfnAgentPropsMixin.AgentTagProperty> tags) Sets the value ofCfnAgentMixinProps.getTags()welcomeMessage(String welcomeMessage) Sets the value ofCfnAgentMixinProps.getWelcomeMessage()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
actionConnectors
@Stability(Stable) public CfnAgentMixinProps.Builder actionConnectors(List<String> actionConnectors) Sets the value ofCfnAgentMixinProps.getActionConnectors()- Parameters:
actionConnectors- A list of ActionConnector ARNs (max 10) attached to the agent.- Returns:
this
-
agentId
Sets the value ofCfnAgentMixinProps.getAgentId()- Parameters:
agentId- The unique identifier for the agent.- Returns:
this
-
agentLifecycle
Sets the value ofCfnAgentMixinProps.getAgentLifecycle()- Parameters:
agentLifecycle- The lifecycle stage of the agent. PREVIEW or PUBLISHED.- Returns:
this
-
awsAccountId
Sets the value ofCfnAgentMixinProps.getAwsAccountId()- Parameters:
awsAccountId- The ID of the Amazon Web Services account where the agent is being created.- Returns:
this
-
customPromptInput
@Stability(Stable) public CfnAgentMixinProps.Builder customPromptInput(IResolvable customPromptInput) Sets the value ofCfnAgentMixinProps.getCustomPromptInput()- Parameters:
customPromptInput- Custom prompt configuration. Specify either ExistingPrompt or NewPrompt.- Returns:
this
-
customPromptInput
@Stability(Stable) public CfnAgentMixinProps.Builder customPromptInput(CfnAgentPropsMixin.CustomPromptInputProperty customPromptInput) Sets the value ofCfnAgentMixinProps.getCustomPromptInput()- Parameters:
customPromptInput- Custom prompt configuration. Specify either ExistingPrompt or NewPrompt.- Returns:
this
-
description
Sets the value ofCfnAgentMixinProps.getDescription()- Parameters:
description- A description of the agent.- Returns:
this
-
iconId
Sets the value ofCfnAgentMixinProps.getIconId()- Parameters:
iconId- The icon identifier for the agent.- Returns:
this
-
name
Sets the value ofCfnAgentMixinProps.getName()- Parameters:
name- The display name of the agent.- Returns:
this
-
spaces
Sets the value ofCfnAgentMixinProps.getSpaces()- Parameters:
spaces- A list of Space ARNs (max 10) attached to the agent.- Returns:
this
-
starterPrompts
Sets the value ofCfnAgentMixinProps.getStarterPrompts()- Parameters:
starterPrompts- A list of up to 3 starter prompts displayed to users.- Returns:
this
-
tags
@Stability(Stable) public CfnAgentMixinProps.Builder tags(List<? extends CfnAgentPropsMixin.AgentTagProperty> tags) Sets the value ofCfnAgentMixinProps.getTags()- Parameters:
tags- A list of key-value pairs to associate with the agent resource.- Returns:
this
-
welcomeMessage
Sets the value ofCfnAgentMixinProps.getWelcomeMessage()- Parameters:
welcomeMessage- The welcome message displayed when a user opens the agent.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnAgentMixinProps>- Returns:
- a new instance of
CfnAgentMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-