Interface: IAgentAlias
May 8, 2026 ยท View on GitHub
@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / bedrock / IAgentAlias
Interface: IAgentAlias
Represents an Agent Alias, either created with CDK or imported.
Extends
IResource
Properties
agent
readonlyagent:IAgent
The underlying agent for this alias.
aliasArn
readonlyaliasArn:string
The ARN of the agent alias.
Example
`arn:aws:bedrock:us-east-1:123456789012:agent-alias/DNCJJYQKSU/TCLCITFZTN`
aliasId
readonlyaliasId:string
The unique identifier of the agent alias.
Example
`TCLCITFZTN`
env
readonlyenv:ResourceEnvironment
The environment this resource belongs to.
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.
Inherited from
IResource.env
node
readonlynode:Node
The tree node.
Inherited from
IResource.node
stack
readonlystack:Stack
The stack in which this resource is defined.
Inherited from
IResource.stack
Methods
applyRemovalPolicy()
applyRemovalPolicy(
policy):void
Apply the given removal policy to this resource
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).
Parameters
policy
RemovalPolicy
Returns
void
Inherited from
IResource.applyRemovalPolicy
grant()
grant(
grantee, ...actions):Grant
Grant the given principal identity permissions to perform actions on this agent alias.
Parameters
grantee
IGrantable
actions
...string[]
Returns
Grant
grantGet()
grantGet(
grantee):Grant
Grant the given identity permissions to get the agent alias.
Parameters
grantee
IGrantable
Returns
Grant
grantInvoke()
grantInvoke(
grantee):Grant
Grant the given identity permissions to invoke the agent alias.
Parameters
grantee
IGrantable
Returns
Grant
onCloudTrailEvent()
onCloudTrailEvent(
id,options?):Rule
Define an EventBridge rule that triggers when something happens to this agent alias
Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
Parameters
id
string
The id of the rule
options?
OnEventOptions
Options for adding the rule
Returns
Rule
with()
with(...
mixins):IConstruct
Applies one or more mixins to this construct.
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.
Parameters
mixins
...IMixin[]
The mixins to apply
Returns
IConstruct
This construct for chaining
Inherited from
IResource.with