Package software.amazon.awscdk.services.quicksight

Class CfnAgentProps.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnAgentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentProps>

Enclosing interface:

CfnAgentProps

@Stability(Stable)
public static final class CfnAgentProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAgentProps>

A builder for CfnAgentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAgentProps.Builder	actionConnectors(List<String> actionConnectors)	Sets the value of CfnAgentProps.getActionConnectors()
CfnAgentProps.Builder	agentId(String agentId)	Sets the value of CfnAgentProps.getAgentId()
CfnAgentProps.Builder	agentLifecycle(String agentLifecycle)	Sets the value of CfnAgentProps.getAgentLifecycle()
CfnAgentProps.Builder	awsAccountId(String awsAccountId)	Sets the value of CfnAgentProps.getAwsAccountId()
CfnAgentProps	build()	Builds the configured instance.
CfnAgentProps.Builder	customPromptInput(IResolvable customPromptInput)	Sets the value of CfnAgentProps.getCustomPromptInput()
CfnAgentProps.Builder	customPromptInput(CfnAgent.CustomPromptInputProperty customPromptInput)	Sets the value of CfnAgentProps.getCustomPromptInput()
CfnAgentProps.Builder	description(String description)	Sets the value of CfnAgentProps.getDescription()
CfnAgentProps.Builder	iconId(String iconId)	Sets the value of CfnAgentProps.getIconId()
CfnAgentProps.Builder	name(String name)	Sets the value of CfnAgentProps.getName()
CfnAgentProps.Builder	spaces(List<String> spaces)	Sets the value of CfnAgentProps.getSpaces()
CfnAgentProps.Builder	starterPrompts(List<String> starterPrompts)	Sets the value of CfnAgentProps.getStarterPrompts()
CfnAgentProps.Builder	tags(List<? extends CfnAgent.AgentTagProperty> tags)	Sets the value of CfnAgentProps.getTags()
CfnAgentProps.Builder	welcomeMessage(String welcomeMessage)	Sets the value of CfnAgentProps.getWelcomeMessage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

agentId

@Stability(Stable)
public CfnAgentProps.Builder agentId(String agentId)

Sets the value of CfnAgentProps.getAgentId()

Parameters:

agentId - The unique identifier for the agent. This parameter is required.

Returns:

this

awsAccountId

@Stability(Stable)
public CfnAgentProps.Builder awsAccountId(String awsAccountId)

Sets the value of CfnAgentProps.getAwsAccountId()

Parameters:

awsAccountId - The ID of the Amazon Web Services account where the agent is being created. This parameter is required.

Returns:

this

name

@Stability(Stable)
public CfnAgentProps.Builder name(String name)

Sets the value of CfnAgentProps.getName()

Parameters:

name - The display name of the agent. This parameter is required.

Returns:

this

actionConnectors

@Stability(Stable)
public CfnAgentProps.Builder actionConnectors(List<String> actionConnectors)

Sets the value of CfnAgentProps.getActionConnectors()

Parameters:

actionConnectors - A list of ActionConnector ARNs (max 10) attached to the agent.

Returns:

this

agentLifecycle

@Stability(Stable)
public CfnAgentProps.Builder agentLifecycle(String agentLifecycle)

Sets the value of CfnAgentProps.getAgentLifecycle()

Parameters:

agentLifecycle - The lifecycle stage of the agent. PREVIEW or PUBLISHED.

Returns:

this

customPromptInput

@Stability(Stable)
public CfnAgentProps.Builder customPromptInput(IResolvable customPromptInput)

Sets the value of CfnAgentProps.getCustomPromptInput()

Parameters:

customPromptInput - Custom prompt configuration. Specify either ExistingPrompt or NewPrompt.

Returns:

this

customPromptInput

@Stability(Stable)
public CfnAgentProps.Builder customPromptInput(CfnAgent.CustomPromptInputProperty customPromptInput)

Sets the value of CfnAgentProps.getCustomPromptInput()

Parameters:

customPromptInput - Custom prompt configuration. Specify either ExistingPrompt or NewPrompt.

Returns:

this

description

@Stability(Stable)
public CfnAgentProps.Builder description(String description)

Sets the value of CfnAgentProps.getDescription()

Parameters:

description - A description of the agent.

Returns:

this

iconId

@Stability(Stable)
public CfnAgentProps.Builder iconId(String iconId)

Sets the value of CfnAgentProps.getIconId()

Parameters:

iconId - The icon identifier for the agent.

Returns:

this

spaces

@Stability(Stable)
public CfnAgentProps.Builder spaces(List<String> spaces)

Sets the value of CfnAgentProps.getSpaces()

Parameters:

spaces - A list of Space ARNs (max 10) attached to the agent.

Returns:

this

starterPrompts

@Stability(Stable)
public CfnAgentProps.Builder starterPrompts(List<String> starterPrompts)

Sets the value of CfnAgentProps.getStarterPrompts()

Parameters:

starterPrompts - A list of up to 3 starter prompts displayed to users.

Returns:

this

tags

@Stability(Stable)
public CfnAgentProps.Builder tags(List<? extends CfnAgent.AgentTagProperty> tags)

Sets the value of CfnAgentProps.getTags()

Parameters:

tags - A list of key-value pairs to associate with the agent resource.

Returns:

this

welcomeMessage

@Stability(Stable)
public CfnAgentProps.Builder welcomeMessage(String welcomeMessage)

Sets the value of CfnAgentProps.getWelcomeMessage()

Parameters:

welcomeMessage - The welcome message displayed when a user opens the agent.

Returns:

this

build

@Stability(Stable)
public CfnAgentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAgentProps>

Returns:

a new instance of CfnAgentProps

Throws:

NullPointerException - if any required attribute was not provided