Interface CfnAgentProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAgentProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
date="2026-08-10T14:51:08.177Z")
@Stability(Stable)
public interface CfnAgentProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnAgent.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;
CfnAgentProps cfnAgentProps = CfnAgentProps.builder()
.agentId("agentId")
.awsAccountId("awsAccountId")
.name("name")
// the properties below are optional
.actionConnectors(List.of("actionConnectors"))
.agentLifecycle("agentLifecycle")
.customPromptInput(CustomPromptInputProperty.builder()
.existingPrompt(CustomPromptProfileProperty.builder()
.modelProfileId("modelProfileId")
.qbsAwsAccountId("qbsAwsAccountId")
.subscriptionId("subscriptionId")
.build())
.newPrompt(CustomPromptInputParametersProperty.builder()
.customInstructions("customInstructions")
.identity("identity")
.outputStyle("outputStyle")
.responseLength("responseLength")
.tone("tone")
.build())
.build())
.description("description")
.iconId("iconId")
.spaces(List.of("spaces"))
.starterPrompts(List.of("starterPrompts"))
.tags(List.of(AgentTagProperty.builder()
.key("key")
.value("value")
.build()))
.welcomeMessage("welcomeMessage")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAgentPropsstatic final classAn implementation forCfnAgentProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAgentProps.Builderbuilder()A list of ActionConnector ARNs (max 10) attached to the agent.The unique identifier for the agent.default StringThe lifecycle stage of the agent.The ID of the Amazon Web Services account where the agent is being created.default ObjectCustom prompt configuration.default StringA description of the agent.default StringThe icon identifier for the agent.getName()The display name of the agent.A list of Space ARNs (max 10) attached to the agent.A list of up to 3 starter prompts displayed to users.default List<CfnAgent.AgentTagProperty> getTags()A list of key-value pairs to associate with the agent resource.default StringThe welcome message displayed when a user opens the agent.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAgentId
The unique identifier for the agent.- See Also:
-
getAwsAccountId
The ID of the Amazon Web Services account where the agent is being created.- See Also:
-
getName
The display name of the agent.- See Also:
-
getActionConnectors
A list of ActionConnector ARNs (max 10) attached to the agent.- See Also:
-
getAgentLifecycle
The lifecycle stage of the agent.PREVIEW or PUBLISHED.
- See Also:
-
getCustomPromptInput
Custom prompt configuration.Specify either ExistingPrompt or NewPrompt.
Returns union: either
IResolvableorCfnAgent.CustomPromptInputProperty- See Also:
-
getDescription
A description of the agent.- See Also:
-
getIconId
The icon identifier for the agent.- See Also:
-
getSpaces
A list of Space ARNs (max 10) attached to the agent.- See Also:
-
getStarterPrompts
A list of up to 3 starter prompts displayed to users.- See Also:
-
getTags
A list of key-value pairs to associate with the agent resource.- See Also:
-
getWelcomeMessage
The welcome message displayed when a user opens the agent.- See Also:
-
builder
- Returns:
- a
CfnAgentProps.BuilderofCfnAgentProps
-