> **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.
# RuntimeBase

Base class for Agent Runtime.

Extends: Construct › Resource › RuntimeBase
Implements: IBedrockAgentRuntime, IResource, IConnectable, IGrantable, IEnvironmentAware, IRuntimeRef, IConstruct, IDependable
Superclass of: Runtime

- Source: [`lib/runtime/runtime-base.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/runtime/runtime-base.ts#L199)

## Initializer

```ts
new RuntimeBase(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

- `agentRuntimeArn`: string — The ARN of the agent runtime resource - Format `arn:${Partition}:bedrock-agentcore:${Region}:${Account}:runtime/${RuntimeId}`.

- `agentRuntimeId`: string — The ID of the agent runtime.

- `agentRuntimeName`: string — The name of the agent runtime.

- `agentRuntimeVersion`: string — The version of the agent runtime.

- `agentStatus`: string — The current status of the agent runtime.

- `connections`: [Connections](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Connections.html) — An accessor for the Connections object that will fail if this Runtime does not have a VPC configured.

- `createdAt`: string — The time at which the runtime was created.

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

- `lastUpdatedAt`: string — The time at which the runtime was last updated.

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

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The IAM role that provides permissions for the agent runtime.

- `runtimeRef`: [RuntimeReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_bedrockagentcore.RuntimeReference.html) — A reference to a Runtime resource.

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

## Methods

- `addToRolePolicy(statement: PolicyStatement): IBedrockAgentRuntime` — Adds a policy statement to the runtime's execution role.

  **Parameters**

  - `statement` — The IAM policy statement to add.

  **Returns:** The runtime instance for chaining

- `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(actions: string[], resources: string[]): Grant` — Grant the runtime specific actions on AWS resources.

  [disable-awslint:no-grants]

  **Parameters**

  - `actions` — The actions to grant.
  - `resources` — The resource ARNs to grant access to.

  **Returns:** The Grant object for chaining

- `grantInvoke(grantee: IGrantable): Grant` — Permits an IAM principal to invoke this runtime both directly and on behalf of users Grants both bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser permissions.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — The principal to grant access to.

- `grantInvokeRuntime(grantee: IGrantable): Grant` — Permits an IAM principal to invoke this runtime Grants the bedrock-agentcore:InvokeAgentRuntime permission.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — The principal to grant access to.

- `grantInvokeRuntimeForUser(grantee: IGrantable): Grant` — Permits an IAM principal to invoke this runtime on behalf of a user Grants the bedrock-agentcore:InvokeAgentRuntimeForUser permission Required when using the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — The principal to grant access to.

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

  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.

- `metricInvocations(props?: MetricOptions): Metric` — Return a metric containing the total number of invocations for this agent runtime.

- `metricInvocationsAggregated(props?: MetricOptions): Metric` — Return a metric containing the total number of invocations across all resources.

- `metricLatency(props?: MetricOptions): Metric` — Return a metric measuring the latency of requests for this agent runtime.

  The latency metric represents the total time elapsed between receiving the request
  and sending the final response token, representing complete end-to-end processing time.

- `metricSessionCount(props?: MetricOptions): Metric` — Return a metric containing the number of agent sessions for this agent runtime.

- `metricSessionsAggregated(props?: MetricOptions): Metric` — Return a metric containing the total number of sessions across all resources.

- `metricSystemErrors(props?: MetricOptions): Metric` — Return a metric containing the number of system errors for this agent runtime.

- `metricThrottles(props?: MetricOptions): Metric` — Return a metric containing the number of throttled requests for this agent runtime.

- `metricTotalErrors(props?: MetricOptions): Metric` — Return a metric containing the total number of errors (system + user) for this agent runtime.

- `metricUserErrors(props?: MetricOptions): Metric` — Return a metric containing the number of user errors for this agent runtime.

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