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

Abstract base class for a PolicyEngine.

Contains methods and attributes valid for PolicyEngines either created with CDK or imported.

Extends: Construct › Resource › PolicyEngineBase
Implements: IPolicyEngine, IResource, IGrantable, IEnvironmentAware, IPolicyEngineRef, IConstruct, IDependable
Superclass of: PolicyEngine

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/policy/policy-engine-base.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/policy/policy-engine-base.ts#L168)

## Initializer

```ts
new PolicyEngineBase(scope: Construct, id: string, props?: ResourceProps)
```

## Construct Props

- `account`: string — The AWS account ID this resource belongs to.

  **Default:** the resource is in the same account as the stack it belongs to

- `environmentFromArn`: string — ARN to deduce region and account from.

  **Default:** take environment from `account`, `region` parameters, or use Stack environment.

  The ARN is parsed and the account and region are taken from the ARN.
  This should be used for imported resources.

  Cannot be supplied together with either `account` or `region`.

- `physicalName`: string — The value passed in by users to the physical name prop of the resource.

  **Default:** The physical name will be allocated by CloudFormation at deployment time

  - `undefined` implies that a physical name will be allocated by
    CloudFormation during deployment.
  - a concrete value implies a specific physical name
  - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
    by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

- `region`: string — The AWS region this resource belongs to.

  **Default:** the resource is in the same region as the stack it belongs to

## Properties

- `description`: string — The description of the policy engine.

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

- `grantPrincipal`: [IPrincipal](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IPrincipal.html) — The principal to grant permissions to.

- `kmsKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The KMS key used for encryption.

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

- `policyEngineArn`: string — The ARN of the policy engine resource.

- `policyEngineId`: string — The ID of the policy engine.

- `policyEngineName`: string — The name of the policy engine.

- `policyEngineRef`: [PolicyEngineReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_bedrockagentcore.PolicyEngineReference.html) — A reference to this PolicyEngine resource.

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

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Grants IAM actions to the IAM Principal.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — - The IAM principal to grant permissions to.
  - `actions` — - The actions to grant.

  **Returns:** An IAM Grant object representing the granted permissions

- `grantEvaluate(grantee: IGrantable): Grant` — Grants permissions to evaluate policies at runtime (data plane operations).

  This is the primary permission needed by Gateway execution roles to evaluate
  authorization decisions during agent requests. Grant this to roles that need
  to call AuthorizeAction or PartiallyAuthorizeActions at runtime.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — - The IAM principal to grant evaluation permissions to.

  **Returns:** An IAM Grant object representing the granted permissions

- `grantEvaluateForGateway(grantee: IGrantable, gateway: IGateway): Grant` — Grants the full set of permissions required for a gateway execution role to use this policy engine, correctly scoped to both the policy engine and gateway ARNs.

  Per the AWS docs:
  - `GetPolicyEngine` → policy engine ARN only
  - `AuthorizeAction` + `PartiallyAuthorizeActions` → policy engine ARN **and** gateway ARN

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — - The IAM principal (gateway execution role) to grant permissions to.
  - `gateway` — - The gateway that will use this policy engine [disable-awslint:prefer-ref-interface].

  **Returns:** A combined IAM Grant representing all granted permissions

- `grantRead(grantee: IGrantable): Grant` — Grants read permissions on the PolicyEngine (data plane).

  This grants runtime read access to policy engine configuration. Use this for
  monitoring, observability, or read-only administrative roles that need to inspect
  policy engine settings at runtime.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — - The IAM principal to grant read permissions to.

  **Returns:** An IAM Grant object representing the granted permissions

- `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.

- `metric(metricName: string, dimensions: { [key: string]: string }, props?: MetricOptions): Metric` — Return the given named metric for this policy engine.

  By default, the metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

  **Parameters**

  - `metricName` — The name of the metric.
  - `dimensions` — Additional dimensions for the metric.
  - `props` — Optional metric configuration.

- `metricAuthorizationLatency(props?: MetricOptions): Metric` — Return a metric measuring the authorization latency for this policy engine.

  This metric represents the time taken to evaluate authorization policies.

  **Parameters**

  - `props` — Optional metric configuration.

- `metricAuthorizations(props?: MetricOptions): Metric` — Return a metric containing the total number of authorizations for this policy engine.

  This metric tracks all authorization requests processed by the policy engine.

  **Parameters**

  - `props` — Optional metric configuration.

- `metricDeniedRequests(props?: MetricOptions): Metric` — Return a metric containing the number of denied authorization requests for this policy engine.

  This metric tracks authorization requests that were explicitly denied by policies.

  **Parameters**

  - `props` — Optional metric configuration.

- `metricErrors(props?: MetricOptions): Metric` — Return a metric containing the number of errors during authorization for this policy engine.

  This metric tracks errors encountered during policy evaluation.

  **Parameters**

  - `props` — Optional metric configuration.

- `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.
