Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
AgentAlias L1 construct
Class to create an Agent Alias with CDK.
Example
// Create a specialized agent
const customerSupportAgent = new bedrock.Agent(this, 'CustomerSupportAgent', {
instruction: 'You specialize in answering customer support questions.',
foundationModel: bedrock.BedrockFoundationModel.AMAZON_NOVA_LITE_V1,
});
// Create an agent alias
const customerSupportAlias = new bedrock.AgentAlias(this, 'CustomerSupportAlias', {
agent: customerSupportAgent,
agentAliasName: 'production',
});
// Create a main agent that collaborates with the specialized agent
const mainAgent = new bedrock.Agent(this, 'MainAgent', {
instruction: 'You route specialized questions to other agents.',
foundationModel: bedrock.BedrockFoundationModel.AMAZON_NOVA_LITE_V1,
agentCollaboration: {
type: bedrock.AgentCollaboratorType.SUPERVISOR,
collaborators: [
new bedrock.AgentCollaborator({
agentAlias: customerSupportAlias,
collaborationInstruction: 'Route customer support questions to this agent.',
collaboratorName: 'CustomerSupport',
relayConversationHistory: true
}),
],
},
});
# Create a specialized agent
customer_support_agent = bedrock.Agent(self, "CustomerSupportAgent",
instruction="You specialize in answering customer support questions.",
foundation_model=bedrock.BedrockFoundationModel.AMAZON_NOVA_LITE_V1
)
# Create an agent alias
customer_support_alias = bedrock.AgentAlias(self, "CustomerSupportAlias",
agent=customer_support_agent,
agent_alias_name="production"
)
# Create a main agent that collaborates with the specialized agent
main_agent = bedrock.Agent(self, "MainAgent",
instruction="You route specialized questions to other agents.",
foundation_model=bedrock.BedrockFoundationModel.AMAZON_NOVA_LITE_V1,
agent_collaboration={
"type": bedrock.AgentCollaboratorType.SUPERVISOR,
"collaborators": [
bedrock.AgentCollaborator(
agent_alias=customer_support_alias,
collaboration_instruction="Route customer support questions to this agent.",
collaborator_name="CustomerSupport",
relay_conversation_history=True
)
]
}
)
// Create a specialized agent
Agent customerSupportAgent = Agent.Builder.create(this, "CustomerSupportAgent")
.instruction("You specialize in answering customer support questions.")
.foundationModel(BedrockFoundationModel.AMAZON_NOVA_LITE_V1)
.build();
// Create an agent alias
AgentAlias customerSupportAlias = AgentAlias.Builder.create(this, "CustomerSupportAlias")
.agent(customerSupportAgent)
.agentAliasName("production")
.build();
// Create a main agent that collaborates with the specialized agent
Agent mainAgent = Agent.Builder.create(this, "MainAgent")
.instruction("You route specialized questions to other agents.")
.foundationModel(BedrockFoundationModel.AMAZON_NOVA_LITE_V1)
.agentCollaboration(Map.of(
"type", AgentCollaboratorType.SUPERVISOR,
"collaborators", List.of(
AgentCollaborator.Builder.create()
.agentAlias(customerSupportAlias)
.collaborationInstruction("Route customer support questions to this agent.")
.collaboratorName("CustomerSupport")
.relayConversationHistory(true)
.build())))
.build();
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
// Create a specialized agent
var customerSupportAgent = new Agent(this, "CustomerSupportAgent", new AgentProps {
Instruction = "You specialize in answering customer support questions.",
FoundationModel = BedrockFoundationModel.AMAZON_NOVA_LITE_V1
});
// Create an agent alias
var customerSupportAlias = new AgentAlias(this, "CustomerSupportAlias", new AgentAliasProps {
Agent = customerSupportAgent,
AgentAliasName = "production"
});
// Create a main agent that collaborates with the specialized agent
var mainAgent = new Agent(this, "MainAgent", new AgentProps {
Instruction = "You route specialized questions to other agents.",
FoundationModel = BedrockFoundationModel.AMAZON_NOVA_LITE_V1,
AgentCollaboration = new Dictionary<string, object> {
{ "type", AgentCollaboratorType.SUPERVISOR },
{ "collaborators", new [] {
new AgentCollaborator(new AgentCollaboratorProps {
AgentAlias = customerSupportAlias,
CollaborationInstruction = "Route customer support questions to this agent.",
CollaboratorName = "CustomerSupport",
RelayConversationHistory = true
}) } }
}
});
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
// Create a specialized agent
customerSupportAgent := bedrock.NewAgent(this, jsii.String("CustomerSupportAgent"), &AgentProps{
Instruction: jsii.String("You specialize in answering customer support questions."),
FoundationModel: bedrock.BedrockFoundationModel_AMAZON_NOVA_LITE_V1(),
})
// Create an agent alias
customerSupportAlias := bedrock.NewAgentAlias(this, jsii.String("CustomerSupportAlias"), &AgentAliasProps{
Agent: customerSupportAgent,
AgentAliasName: jsii.String("production"),
})
// Create a main agent that collaborates with the specialized agent
mainAgent := bedrock.NewAgent(this, jsii.String("MainAgent"), &AgentProps{
Instruction: jsii.String("You route specialized questions to other agents."),
FoundationModel: bedrock.BedrockFoundationModel_AMAZON_NOVA_LITE_V1(),
AgentCollaboration: map[string]interface{}{
"type": bedrock.AgentCollaboratorType_SUPERVISOR,
"collaborators": []AgentCollaborator{
bedrock.NewAgentCollaborator(&AgentCollaboratorProps{
"agentAlias": customerSupportAlias,
"collaborationInstruction": jsii.String("Route customer support questions to this agent."),
"collaboratorName": jsii.String("CustomerSupport"),
"relayConversationHistory": jsii.Boolean(true),
}),
},
},
})
Initializer
new AgentAlias(scope: Construct, id: string, props: AgentAliasProps)
AgentAlias(scope: Construct, id: str, props: AgentAliasProps)
new AgentAlias(Construct scope, String id, AgentAliasProps props)
new AgentAlias(Construct scope, string id, AgentAliasProps props)
NewAgentAlias(Scope Construct, Id *string, Props AgentAliasProps)
Construct Props
agentAliasNameoptionalstringagent_alias_nameoptionalstragentAliasNameoptionalStringAgentAliasNameoptionalstringAgentAliasNameoptional*string= "latest"#This will be used as the physical name of the agent alias.
agentVersionoptionalstringagent_versionoptionalstragentVersionoptionalStringAgentVersionoptionalstringAgentVersionoptional*string#Default: Creates a new version of the agent.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: undefined - No description is provided
Properties
This is either provided by the user or generated from a hash.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromAttributes(scope: Construct, id: string, attrs: AgentAliasAttributes): IAgentAlias@staticmethod def from_attributes(scope: Construct, id: str, attrs: AgentAliasAttributes) -> IAgentAliaspublic static IAgentAlias fromAttributes(Construct scope, String id, AgentAliasAttributes attrs)public static IAgentAlias FromAttributes(Construct scope, string id, AgentAliasAttributes attrs)func FromAttributes(Scope Construct, Id *string, Attrs AgentAliasAttributes) IAgentAliasstatic#grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#Note: This grant will only work when the grantee is in the same AWS account where the agent alias is defined. Cross-account grant is not supported. [disable-awslint:no-grants]
grantGet(grantee: IGrantable): Grantdef grant_get(self, grantee: IGrantable) -> Grantpublic Grant grantGet(IGrantable grantee)public Grant GrantGet(IGrantable grantee)func GrantGet(Grantee IGrantable) Grant#Note: This grant will only work when the grantee is in the same AWS account where the agent alias is defined. Cross-account agent read is not supported. [disable-awslint:no-grants]
grantInvoke(grantee: IGrantable): Grantdef grant_invoke(self, grantee: IGrantable) -> Grantpublic Grant grantInvoke(IGrantable grantee)public Grant GrantInvoke(IGrantable grantee)func GrantInvoke(Grantee IGrantable) Grant#Note: This grant will only work when the grantee is in the same AWS account where the agent alias is defined. Cross-account invocation is not supported. [disable-awslint:no-grants]
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#onCloudTrailEvent(id: string, options?: OnEventOptions): Ruledef on_cloud_trail_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onCloudTrailEvent(String id, OnEventOptions options)public Rule OnCloudTrailEvent(string id, OnEventOptions? options = null)func OnCloudTrailEvent(Id *string, Options OnEventOptions) Rule#Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
2 parameters
Parameters
ididididId— The id of the rule.optionsoptionsoptionsoptionsOptions— Options for adding the rule.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.