> **Experimental**
>
> `@aws-cdk/aws-bedrock-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# AgentAlias

Class to create an Agent Alias with CDK.

Extends: Construct › Resource › AgentAliasBase › AgentAlias
Implements: IAgentAlias, IResource, IEnvironmentAware, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- CloudFormation: [`AWS::Bedrock::AgentAlias`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-bedrock-agentalias.html)
- Source: [`bedrock/agents/agent-alias.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0-alpha.0/packages/@aws-cdk/aws-bedrock-alpha/bedrock/agents/agent-alias.ts#L194)

## Example

```ts
// 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
      }),
    ],
  },
});
```

## Initializer

```ts
new AgentAlias(scope: Construct, id: string, props: AgentAliasProps)
```

## Construct Props

- `agent`: [IAgent](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.IAgent.html) (required) — The agent associated to this alias.

- `agentAliasName`: string = "latest" — The name for the agent alias.

  This will be used as the physical name of the agent alias.

- `agentVersion`: string — The version of the agent to associate with the agent alias.

  **Default:** Creates a new version of the agent.

- `description`: string — Description for the agent alias.

  **Default:** undefined - No description is provided

## Properties

- `agent`: [IAgent](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.IAgent.html) (required) — The underlying agent for this alias.

- `aliasArn`: string (required) — The ARN of the agent alias.

- `aliasId`: string (required) — The unique identifier of the agent alias.

- `aliasName`: string (required) — The name of the agent alias.

  This is either provided by the user or generated from a hash.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — 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.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  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**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): 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`).

- `fromAttributes(scope: Construct, id: string, attrs: AgentAliasAttributes): IAgentAlias` (static) — Brings an Agent Alias from an existing one created outside of CDK.

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Grant the given principal identity permissions to perform actions on this agent alias.

  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): Grant` — Grant the given identity permissions to get the agent alias.

  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): Grant` — Grant the given identity permissions to invoke the agent alias.

  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` (static) — Checks if `x` is a construct.

  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**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `onCloudTrailEvent(id: string, options?: OnEventOptions): 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` — The id of the rule.
  - `options` — Options for adding the rule.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): 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.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.