AWS::BedrockAgentCore::CodeInterpreterCustom - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::BedrockAgentCore::CodeInterpreterCustom

The AgentCore Code Interpreter tool enables agents to securely execute code in isolated sandbox environments. It offers advanced configuration support and seamless integration with popular frameworks.

For more information about using the custom code interpreter, see Execute code and analyze data using Amazon Bedrock AgentCore Code Interpreter.

See the Properties section below for descriptions of both the required and optional properties.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::BedrockAgentCore::CodeInterpreterCustom",
  "Properties" : {
      "Description" : String,
      "ExecutionRoleArn" : String,
      "Name" : String,
      "NetworkConfiguration" : CodeInterpreterNetworkConfiguration,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::BedrockAgentCore::CodeInterpreterCustom
Properties:
  Description: String
  ExecutionRoleArn: String
  Name: String
  NetworkConfiguration: 
    CodeInterpreterNetworkConfiguration
  Tags: 
    Key: Value

Properties

Description

The description of the code interpreter.

Required: No

Type: String

Update requires: Replacement

ExecutionRoleArn

The IAM role ARN that provides permissions for the code interpreter.

Required: No

Type: String

Pattern: ^arn:aws(-[a-z]+)*:iam::[0-9]{12}:role/.+$

Update requires: Replacement

Name

The name of the code interpreter.

Required: Yes

Type: String

Update requires: Replacement

NetworkConfiguration

The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.

Required: Yes

Type: CodeInterpreterNetworkConfiguration

Update requires: Replacement

Tags

A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CodeInterpreterArn

The code interpreter Amazon Resource Name (ARN).

CodeInterpreterId

The unique identifier of the created code interpreter.

CreatedAt

The timestamp when the code interpreter was created.

FailureReason

The reason for failure if the code interpreter is in a failed state.

LastUpdatedAt

The time at which the code interpreter was last updated.

Status

The status of the custom code interpreter.