AWS CDK

2.264.0

interface CfnAgentProps

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnAgentProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAgentProps`
Java	`software.amazon.awscdk.services.quicksight.CfnAgentProps`
Python	`aws_cdk.aws_quicksight.CfnAgentProps`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnAgentProps`

Properties for defining a CfnAgent.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnAgentProps: quicksight.CfnAgentProps = {
  agentId: 'agentId',
  awsAccountId: 'awsAccountId',
  name: 'name',

  // the properties below are optional
  actionConnectors: ['actionConnectors'],
  agentLifecycle: 'agentLifecycle',
  customPromptInput: {
    existingPrompt: {
      modelProfileId: 'modelProfileId',
      qbsAwsAccountId: 'qbsAwsAccountId',
      subscriptionId: 'subscriptionId',
    },
    newPrompt: {
      customInstructions: 'customInstructions',
      identity: 'identity',
      outputStyle: 'outputStyle',
      responseLength: 'responseLength',
      tone: 'tone',
    },
  },
  description: 'description',
  iconId: 'iconId',
  spaces: ['spaces'],
  starterPrompts: ['starterPrompts'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  welcomeMessage: 'welcomeMessage',
};

Properties

Name	Type	Description
agentId	`string`	The unique identifier for the agent.
awsAccountId	`string`	The ID of the Amazon Web Services account where the agent is being created.
name	`string`	The display name of the agent.
actionConnectors?	`string[]`	A list of ActionConnector ARNs (max 10) attached to the agent.
agentLifecycle?	`string`	The lifecycle stage of the agent.
customPromptInput?	`IResolvable` `\|` `CustomPromptInputProperty`	Custom prompt configuration.
description?	`string`	A description of the agent.
iconId?	`string`	The icon identifier for the agent.
spaces?	`string[]`	A list of Space ARNs (max 10) attached to the agent.
starterPrompts?	`string[]`	A list of up to 3 starter prompts displayed to users.
tags?	`AgentTagProperty[]`	A list of key-value pairs to associate with the agent resource.
welcomeMessage?	`string`	The welcome message displayed when a user opens the agent.

agentId

Type: string

The unique identifier for the agent.

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

awsAccountId

Type: string

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

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

name

Type: string

The display name of the agent.

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

actionConnectors?

Type: string[] (optional)

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

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

agentLifecycle?

Type: string (optional)

The lifecycle stage of the agent.

PREVIEW or PUBLISHED.

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

customPromptInput?

Type: IResolvable | CustomPromptInputProperty (optional)

Custom prompt configuration.

Specify either ExistingPrompt or NewPrompt.

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

description?

Type: string (optional)

A description of the agent.

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

iconId?

Type: string (optional)

The icon identifier for the agent.

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

spaces?

Type: string[] (optional)

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

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

starterPrompts?

Type: string[] (optional)

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

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

tags?

Type: AgentTagProperty[] (optional)

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

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

welcomeMessage?

Type: string (optional)

The welcome message displayed when a user opens the agent.

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

← Previous Next →