Interface AgentPromptVariantProps
- All Superinterfaces:
CommonPromptVariantProps
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AgentPromptVariantProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
date="2025-07-29T17:51:11.465Z")
@Stability(Experimental)
public interface AgentPromptVariantProps
extends software.amazon.jsii.JsiiSerializable, CommonPromptVariantProps
(experimental) Properties for creating an agent prompt variant.
Example:
Key cmk = Key.Builder.create(this, "cmk").build(); // Assuming you have an existing agent and alias IAgent agent = Agent.fromAgentAttributes(this, "ImportedAgent", AgentAttributes.builder() .agentArn("arn:aws:bedrock:region:account:agent/agent-id") .roleArn("arn:aws:iam::account:role/agent-role") .build()); IAgentAlias agentAlias = AgentAlias.fromAttributes(this, "ImportedAlias", AgentAliasAttributes.builder() .aliasId("alias-id") .aliasName("my-alias") .agentVersion("1") .agent(agent) .build()); IPromptVariant agentVariant = PromptVariant.agent(AgentPromptVariantProps.builder() .variantName("agent-variant") .model(BedrockFoundationModel.ANTHROPIC_CLAUDE_3_5_SONNET_V1_0) .agentAlias(agentAlias) .promptText("Use the agent to help with: {{task}}. Please be thorough and provide detailed explanations.") .promptVariables(List.of("task")) .build()); Prompt.Builder.create(this, "agentPrompt") .promptName("agent-prompt") .description("Prompt for agent interactions") .defaultVariant(agentVariant) .variants(List.of(agentVariant)) .kmsKey(cmk) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forAgentPromptVariantProps
static final class
An implementation forAgentPromptVariantProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
(experimental) An alias pointing to the agent version to be used.(experimental) The text prompt.Methods inherited from interface software.amazon.awscdk.services.bedrock.alpha.CommonPromptVariantProps
getModel, getPromptVariables, getVariantName
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAgentAlias
(experimental) An alias pointing to the agent version to be used. -
getPromptText
(experimental) The text prompt.Variables are used by enclosing its name with double curly braces as in
{{variable_name}}
. -
builder
- Returns:
- a
AgentPromptVariantProps.Builder
ofAgentPromptVariantProps
-