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

Abstract base class for a Code Interpreter.

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

Extends: Construct › Resource › CodeInterpreterCustomBase
Implements: ICodeInterpreterCustom, IResource, IConnectable, IGrantable, IEnvironmentAware, ICodeInterpreterCustomRef, IConstruct, IDependable
Superclass of: CodeInterpreterCustom

- Source: [`lib/tools/code-interpreter.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0-alpha.0/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/tools/code-interpreter.ts#L178)

## Initializer

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

- `codeInterpreterArn`: string (required) — The ARN of the code interpreter resource.

- `codeInterpreterCustomRef`: [CodeInterpreterCustomReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_bedrockagentcore.CodeInterpreterCustomReference.html) (required) — A reference to a CodeInterpreterCustom resource.

- `codeInterpreterId`: string (required) — The id of the code interpreter.

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

- `createdAt`: string — Timestamp when the code interpreter was created.

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

- `executionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) (required) — The IAM role that provides permissions for the code interpreter to access AWS services.

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

- `lastUpdatedAt`: string — Timestamp when the code interpreter was last updated.

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

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

- `status`: string — The status of the code interpreter.

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

- `grantInvoke(grantee: IGrantable): Grant` — Grant invoke permissions on this code interpreter to an IAM principal.

  [disable-awslint:no-grants]

  **Parameters**

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

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

- `grantRead(grantee: IGrantable): Grant` — Grant read permissions on this code interpreter to an IAM principal.

  This includes both read permissions on the specific code interpreter and list permissions on all code interpreters.

  [disable-awslint:no-grants]

  **Parameters**

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

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

- `grantUse(grantee: IGrantable): Grant` — Grant invoke permissions on this code interpreter to an IAM principal.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — - The IAM principal to grant invoke 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 code interpreter.

  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.

- `metricErrorsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter errors.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter errors

- `metricForApiOperation(metricName: string, operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter api operations..

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter api operations

- `metricInvocationsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter invocations.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter invocations

- `metricLatencyForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter latencies.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter latencies

- `metricSessionDuration(props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter session duration.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter session duration

- `metricSystemErrorsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter system errors.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter system errors

- `metricThrottlesForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter throttles.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter throttles

- `metricUserErrorsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking code interpreter user errors.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for code interpreter user errors

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