Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
AgentAliasAttributes Struct
Attributes needed to create an import.
| Stability | Experimental |
|---|---|
| Source | bedrock/agents/agent-alias.ts |
Example
ts
const cmk = new kms.Key(this, 'cmk', {});
// Assuming you have an existing agent and alias
const agent = bedrock.Agent.fromAgentAttributes(this, 'ImportedAgent', {
agentArn: 'arn:aws:bedrock:region:account:agent/agent-id',
roleArn: 'arn:aws:iam::account:role/agent-role',
});
const agentAlias = bedrock.AgentAlias.fromAttributes(this, 'ImportedAlias', {
aliasId: 'alias-id',
aliasName: 'my-alias',
agentVersion: '1',
agent: agent,
});
const agentVariant = bedrock.PromptVariant.agent({
variantName: 'agent-variant',
model: bedrock.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: ['task'],
});
new bedrock.Prompt(this, 'agentPrompt', {
promptName: 'agent-prompt',
description: 'Prompt for agent interactions',
defaultVariant: agentVariant,
variants: [agentVariant],
kmsKey: cmk,
});
python
cmk = kms.Key(self, "cmk")
# Assuming you have an existing agent and alias
agent = bedrock.Agent.from_agent_attributes(self, "ImportedAgent",
agent_arn="arn:aws:bedrock:region:account:agent/agent-id",
role_arn="arn:aws:iam::account:role/agent-role"
)
agent_alias = bedrock.AgentAlias.from_attributes(self, "ImportedAlias",
alias_id="alias-id",
alias_name="my-alias",
agent_version="1",
agent=agent
)
agent_variant = bedrock.PromptVariant.agent(
variant_name="agent-variant",
model=bedrock.BedrockFoundationModel.ANTHROPIC_CLAUDE_3_5_SONNET_V1_0,
agent_alias=agent_alias,
prompt_text="Use the agent to help with: {{task}}. Please be thorough and provide detailed explanations.",
prompt_variables=["task"]
)
bedrock.Prompt(self, "agentPrompt",
prompt_name="agent-prompt",
description="Prompt for agent interactions",
default_variant=agent_variant,
variants=[agent_variant],
kms_key=cmk
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
var cmk = new Key(this, "cmk", new KeyProps { });
// Assuming you have an existing agent and alias
var agent = Agent.FromAgentAttributes(this, "ImportedAgent", new AgentAttributes {
AgentArn = "arn:aws:bedrock:region:account:agent/agent-id",
RoleArn = "arn:aws:iam::account:role/agent-role"
});
var agentAlias = AgentAlias.FromAttributes(this, "ImportedAlias", new AgentAliasAttributes {
AliasId = "alias-id",
AliasName = "my-alias",
AgentVersion = "1",
Agent = agent
});
var agentVariant = PromptVariant.Agent(new AgentPromptVariantProps {
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 = new [] { "task" }
});
new Prompt(this, "agentPrompt", new PromptProps {
PromptName = "agent-prompt",
Description = "Prompt for agent interactions",
DefaultVariant = agentVariant,
Variants = new [] { agentVariant },
KmsKey = cmk
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
cmk := kms.NewKey(this, jsii.String("cmk"), &KeyProps{
})
// Assuming you have an existing agent and alias
agent := bedrock.Agent_FromAgentAttributes(this, jsii.String("ImportedAgent"), &AgentAttributes{
AgentArn: jsii.String("arn:aws:bedrock:region:account:agent/agent-id"),
RoleArn: jsii.String("arn:aws:iam::account:role/agent-role"),
})
agentAlias := bedrock.AgentAlias_FromAttributes(this, jsii.String("ImportedAlias"), &AgentAliasAttributes{
AliasId: jsii.String("alias-id"),
AliasName: jsii.String("my-alias"),
AgentVersion: jsii.String("1"),
Agent: agent,
})
agentVariant := bedrock.PromptVariant_Agent(&AgentPromptVariantProps{
VariantName: jsii.String("agent-variant"),
Model: bedrock.BedrockFoundationModel_ANTHROPIC_CLAUDE_3_5_SONNET_V1_0(),
AgentAlias: agentAlias,
PromptText: jsii.String("Use the agent to help with: {{task}}. Please be thorough and provide detailed explanations."),
PromptVariables: []*string{
jsii.String("task"),
},
})
bedrock.NewPrompt(this, jsii.String("agentPrompt"), &PromptProps{
PromptName: jsii.String("agent-prompt"),
Description: jsii.String("Prompt for agent interactions"),
DefaultVariant: agentVariant,
Variants: []IPromptVariant{
agentVariant,
},
KmsKey: cmk,
})
Properties
The underlying agent for this alias.
agentVersionstringagent_versionstragentVersionStringAgentVersionstringAgentVersion*string required #The agent version for this alias.
The Id of the agent alias.
aliasNameoptionalstringalias_nameoptionalstraliasNameoptionalStringAliasNameoptionalstringAliasNameoptional*string #The name of the agent alias.
Default: undefined - No alias name is provided