Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Class CfnAgentPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnAgentPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentPropsMixin>

Enclosing class:

CfnAgentPropsMixin

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

A fluent builder for CfnAgentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAgentPropsMixin.Builder	actionConnectors(List<String> actionConnectors)	A list of ActionConnector ARNs (max 10) attached to the agent.
CfnAgentPropsMixin.Builder	agentId(String agentId)	The unique identifier for the agent.
CfnAgentPropsMixin.Builder	agentLifecycle(String agentLifecycle)	The lifecycle stage of the agent.
CfnAgentPropsMixin.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account where the agent is being created.
CfnAgentPropsMixin	build()
static CfnAgentPropsMixin.Builder	create()
static CfnAgentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAgentPropsMixin.Builder	customPromptInput(CfnAgentPropsMixin.CustomPromptInputProperty customPromptInput)	Custom prompt configuration.
CfnAgentPropsMixin.Builder	customPromptInput(IResolvable customPromptInput)	Custom prompt configuration.
CfnAgentPropsMixin.Builder	description(String description)	A description of the agent.
CfnAgentPropsMixin.Builder	iconId(String iconId)	The icon identifier for the agent.
CfnAgentPropsMixin.Builder	name(String name)	The display name of the agent.
CfnAgentPropsMixin.Builder	spaces(List<String> spaces)	A list of Space ARNs (max 10) attached to the agent.
CfnAgentPropsMixin.Builder	starterPrompts(List<String> starterPrompts)	A list of up to 3 starter prompts displayed to users.
CfnAgentPropsMixin.Builder	tags(List<? extends CfnAgentPropsMixin.AgentTagProperty> tags)	A list of key-value pairs to associate with the agent resource.
CfnAgentPropsMixin.Builder	welcomeMessage(String welcomeMessage)	The welcome message displayed when a user opens the agent.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnAgentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAgentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAgentPropsMixin.Builder create()

Returns:

a new instance of CfnAgentPropsMixin.Builder.

actionConnectors

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-actionconnectors

agentId

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

The unique identifier for the agent.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-agentid

agentLifecycle

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

The lifecycle stage of the agent.

PREVIEW or PUBLISHED.

Parameters:

agentLifecycle - The lifecycle stage of the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-agentlifecycle

awsAccountId

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

The ID of the Amazon Web Services account where the agent is being created.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-awsaccountid

customPromptInput

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

Custom prompt configuration.

Specify either ExistingPrompt or NewPrompt.

Parameters:

customPromptInput - Custom prompt configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-custompromptinput

customPromptInput

@Stability(Stable)
public CfnAgentPropsMixin.Builder customPromptInput(CfnAgentPropsMixin.CustomPromptInputProperty customPromptInput)

Custom prompt configuration.

Specify either ExistingPrompt or NewPrompt.

Parameters:

customPromptInput - Custom prompt configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-custompromptinput

description

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

A description of the agent.

Parameters:

description - A description of the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-description

iconId

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

The icon identifier for the agent.

Parameters:

iconId - The icon identifier for the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-iconid

name

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

The display name of the agent.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-name

spaces

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-spaces

starterPrompts

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

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

Parameters:

starterPrompts - A list of up to 3 starter prompts displayed to users. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-starterprompts

tags

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

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

Parameters:

tags - A list of key-value pairs to associate with the agent resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-tags

welcomeMessage

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

The welcome message displayed when a user opens the agent.

Parameters:

welcomeMessage - The welcome message displayed when a user opens the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html#cfn-quicksight-agent-welcomemessage

build

@Stability(Stable)
public CfnAgentPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnAgentPropsMixin.