class CodeInterpreterCustom (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.CodeInterpreterCustom
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#CodeInterpreterCustom
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.CodeInterpreterCustom
Python	aws_cdk.aws_bedrock_agentcore_alpha.CodeInterpreterCustom
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » CodeInterpreterCustom

Implements IConstruct, IDependable, IResource, ICodeInterpreterCustom, IGrantable, IConnectable

Custom code interpreter resource for AWS Bedrock Agent Core.

Provides a sandboxed environment for code execution with configurable network access.

See also: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/code-interpreter.html

Example

// Create a custom execution role
const executionRole = new iam.Role(this, "CodeInterpreterExecutionRole", {
  assumedBy: new iam.ServicePrincipal("bedrock-agentcore.amazonaws.com"),
});

// Create code interpreter with custom execution role
const codeInterpreter = new agentcore.CodeInterpreterCustom(this, "MyCodeInterpreter", {
  codeInterpreterCustomName: "my_code_interpreter",
  description: "Code interpreter with custom execution role",
  networkConfiguration: agentcore.CodeInterpreterNetworkConfiguration.usingPublicNetwork(),
  executionRole: executionRole,
});

Initializer

new CodeInterpreterCustom(scope: Construct, id: string, props: CodeInterpreterCustomProps)

Parameters

• scope Construct
• id string
• props CodeInterpreterCustomProps

Construct Props

Name	Type	Description
codeInterpreterCustomName🔹	string	The name of the code interpreter Valid characters are a-z, A-Z, 0-9, _ (underscore) The name must start with a letter and can be up to 48 characters long Pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}.
description?🔹	string	Optional description for the code interpreter Valid characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and spaces The description can have up to 200 characters.
executionRole?🔹	IRole	The IAM role that provides permissions for the code interpreter to access AWS services.
networkConfiguration?🔹	CodeInterpreterNetworkConfiguration	Network configuration for code interpreter.
tags?🔹	{ [string]: string }	Tags (optional) A list of key:value pairs of tags to apply to this Code Interpreter resource.

---

codeInterpreterCustomName🔹

Type: string

The name of the code interpreter Valid characters are a-z, A-Z, 0-9, _ (underscore) The name must start with a letter and can be up to 48 characters long Pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}.

---

description?🔹

Type: string (optional, default: No description)

Optional description for the code interpreter Valid characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and spaces The description can have up to 200 characters.

---

executionRole?🔹

Type: IRole (optional, default: A new role will be created.)

The IAM role that provides permissions for the code interpreter to access AWS services.

---

networkConfiguration?🔹

Type: CodeInterpreterNetworkConfiguration (optional, default: PUBLIC network mode)

Network configuration for code interpreter.

---

tags?🔹

Type: { [string]: string } (optional, default: {} - no tags)

Tags (optional) A list of key:value pairs of tags to apply to this Code Interpreter resource.

Properties

Name	Type	Description
codeInterpreterArn🔹	string	The ARN of the code interpreter resource.
codeInterpreterId🔹	string	The id of the code interpreter.
connections🔹	Connections	An accessor for the Connections object that will fail if this Browser does not have a VPC configured.
env🔹	ResourceEnvironment	The environment this resource belongs to.
executionRole🔹	IRole	The IAM role that provides permissions for the code interpreter to access AWS services.
grantPrincipal🔹	IPrincipal	The principal to grant permissions to.
name🔹	string	The name of the code interpreter.
networkConfiguration🔹	CodeInterpreterNetworkConfiguration	The network configuration of the code interpreter.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
createdAt?🔹	string	The created timestamp of the code interpreter.
description?🔹	string	The description of the code interpreter.
failureReason?🔹	string	The failure reason of the code interpreter.
lastUpdatedAt?🔹	string	The last updated timestamp of the code interpreter.
status?🔹	string	The status of the code interpreter.
tags?🔹	{ [string]: string }	Tags applied to this code interpreter resource A map of key-value pairs for resource tagging.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

codeInterpreterArn🔹

Type: string

The ARN of the code interpreter resource.

---

codeInterpreterId🔹

Type: string

The id of the code interpreter.

---

connections🔹

Type: Connections

An accessor for the Connections object that will fail if this Browser does not have a VPC configured.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

executionRole🔹

Type: IRole

The IAM role that provides permissions for the code interpreter to access AWS services.

---

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

---

name🔹

Type: string

The name of the code interpreter.

---

networkConfiguration🔹

Type: CodeInterpreterNetworkConfiguration

The network configuration of the code interpreter.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

createdAt?🔹

Type: string (optional)

The created timestamp of the code interpreter.

---

description?🔹

Type: string (optional)

The description of the code interpreter.

---

failureReason?🔹

Type: string (optional)

The failure reason of the code interpreter.

---

lastUpdatedAt?🔹

Type: string (optional)

The last updated timestamp of the code interpreter.

---

status?🔹

Type: string (optional)

The status of the code interpreter.

---

tags?🔹

Type: { [string]: string } (optional, default: No tags applied)

Tags applied to this code interpreter resource A map of key-value pairs for resource tagging.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grants IAM actions to the IAM Principal.
grantInvoke(grantee)🔹	Grant invoke permissions on this code interpreter to an IAM principal.
grantRead(grantee)🔹	Grant read permissions on this code interpreter to an IAM principal.
grantUse(grantee)🔹	Grant invoke permissions on this code interpreter to an IAM principal.
metric(metricName, dimensions, props?)🔹	Return the given named metric for this code interpreter.
metricErrorsForApiOperation(operation, props?)🔹	Creates a CloudWatch metric for tracking code interpreter errors.
metricForApiOperation(metricName, operation, props?)🔹	Creates a CloudWatch metric for tracking code interpreter api operations..
metricInvocationsForApiOperation(operation, props?)🔹	Creates a CloudWatch metric for tracking code interpreter invocations.
metricLatencyForApiOperation(operation, props?)🔹	Creates a CloudWatch metric for tracking code interpreter latencies.
metricSessionDuration(props?)🔹	Creates a CloudWatch metric for tracking code interpreter session duration.
metricSystemErrorsForApiOperation(operation, props?)🔹	Creates a CloudWatch metric for tracking code interpreter system errors.
metricThrottlesForApiOperation(operation, props?)🔹	Creates a CloudWatch metric for tracking code interpreter throttles.
metricUserErrorsForApiOperation(operation, props?)🔹	Creates a CloudWatch metric for tracking code interpreter user errors.
toString()🔹	Returns a string representation of this construct.
static fromCodeInterpreterCustomAttributes(scope, id, attrs)🔹	Creates an Code Interpreter Custom reference from an existing code interpreter's attributes.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — - The IAM principal to grant permissions to.
• actions string — - The actions to grant.

Returns

• Grant

Grants IAM actions to the IAM Principal.

---

grantInvoke(grantee)🔹

public grantInvoke(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — - The IAM principal to grant invoke permissions to.

Returns

• Grant

Grant invoke permissions on this code interpreter to an IAM principal.

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — - The IAM principal to grant read permissions to.

Returns

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

---

grantUse(grantee)🔹

public grantUse(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — - The IAM principal to grant invoke permissions to.

Returns

• Grant

Grant invoke permissions on this code interpreter to an IAM principal.

---

metric(metricName, dimensions, props?)🔹

public metric(metricName: string, dimensions: { [string]: string }, props?: MetricOptions): Metric

Parameters

• metricName string
• dimensions { [string]: string }
• props MetricOptions

Returns

• 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, props?)🔹

public metricErrorsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

• operation string
• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter errors.

---

metricForApiOperation(metricName, operation, props?)🔹

public metricForApiOperation(metricName: string, operation: string, props?: MetricOptions): Metric

Parameters

• metricName string
• operation string
• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter api operations..

---

metricInvocationsForApiOperation(operation, props?)🔹

public metricInvocationsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

• operation string
• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter invocations.

---

metricLatencyForApiOperation(operation, props?)🔹

public metricLatencyForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

• operation string
• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter latencies.

---

metricSessionDuration(props?)🔹

public metricSessionDuration(props?: MetricOptions): Metric

Parameters

• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter session duration.

---

metricSystemErrorsForApiOperation(operation, props?)🔹

public metricSystemErrorsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

• operation string
• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter system errors.

---

metricThrottlesForApiOperation(operation, props?)🔹

public metricThrottlesForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

• operation string
• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter throttles.

---

metricUserErrorsForApiOperation(operation, props?)🔹

public metricUserErrorsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

• operation string
• props MetricOptions — - Configuration options for the metric.

Returns

• Metric

Creates a CloudWatch metric for tracking code interpreter user errors.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromCodeInterpreterCustomAttributes(scope, id, attrs)🔹

public static fromCodeInterpreterCustomAttributes(scope: Construct, id: string, attrs: CodeInterpreterCustomAttributes): ICodeInterpreterCustom

Parameters

• scope Construct — - The construct scope.
• id string — - Identifier of the construct.
• attrs CodeInterpreterCustomAttributes — - Attributes of the existing code interpreter custom.

Returns

• ICodeInterpreterCustom

Creates an Code Interpreter Custom reference from an existing code interpreter's attributes.