class RuntimeEndpoint (construct) 🔹

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

Implements IConstruct, IDependable, IResource, IRuntimeEndpoint

Bedrock Agent Core Runtime Endpoint Provides a stable endpoint for invoking agent runtimes with versioning support.

Example

const repository = new ecr.Repository(this, "TestRepository", {
  repositoryName: "test-agent-runtime",
});

const runtime = new agentcore.Runtime(this, "MyAgentRuntime", {
  runtimeName: "myAgent",
  agentRuntimeArtifact: agentcore.AgentRuntimeArtifact.fromEcrRepository(repository, "v1.0.0"),
});

const prodEndpoint = runtime.addEndpoint("production", {
  version: "1",
  description: "Stable production endpoint - pinned to v1"
});

Initializer

new RuntimeEndpoint(scope: Construct, id: string, props: RuntimeEndpointProps)

Parameters

scope Construct
id string
props RuntimeEndpointProps

Construct Props

Name	Type	Description
agentRuntimeId🔹	`string`	The ID of the agent runtime to associate with this endpoint This is the unique identifier of the runtime resource Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$.
endpointName🔹	`string`	The name of the agent runtime endpoint Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$.
agentRuntimeVersion?🔹	`string`	The version of the agent runtime to use for this endpoint If not specified, the endpoint will point to version "1" of the runtime.
description?🔹	`string`	Optional description for the agent runtime endpoint Length Minimum: 1 , Maximum: 256.
tags?🔹	`{ [string]: string }`	Tags for the agent runtime endpoint A list of key:value pairs of tags to apply to this RuntimeEndpoint resource Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$.

agentRuntimeId🔹

Type: string

The ID of the agent runtime to associate with this endpoint This is the unique identifier of the runtime resource Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$.

endpointName🔹

Type: string

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

agentRuntimeVersion?🔹

Type: string (optional, default: "1")

The version of the agent runtime to use for this endpoint If not specified, the endpoint will point to version "1" of the runtime.

Pattern: ^([1-9][0-9]{0,4})$

description?🔹

Type: string (optional, default: No description)

Optional description for the agent runtime endpoint Length Minimum: 1 , Maximum: 256.

tags?🔹

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

Tags for the agent runtime endpoint A list of key:value pairs of tags to apply to this RuntimeEndpoint resource Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$.

Properties

Name	Type	Description
agentRuntimeArn🔹	`string`	The ARN of the agent runtime associated with this endpoint.
agentRuntimeEndpointArn🔹	`string`	The ARN of the agent runtime endpoint.
agentRuntimeId🔹	`string`	The ID of the agent runtime associated with this endpoint.
agentRuntimeVersion🔹	`string`	The version of the agent runtime used by this endpoint.
endpointId🔹	`string`	The unique identifier of the runtime endpoint.
endpointName🔹	`string`	The name of the endpoint.
env🔹	`ResourceEnvironment`	The environment this resource belongs to.
node🔹	`Node`	The tree node.
stack🔹	`Stack`	The stack in which this resource is defined.
createdAt?🔹	`string`	The timestamp when the endpoint was created.
description?🔹	`string`	Optional description for the endpoint.
lastUpdatedAt?🔹	`string`	When this endpoint was last updated.
liveVersion?🔹	`string`	The live version of the endpoint.
status?🔹	`string`	The status of the endpoint.
targetVersion?🔹	`string`	The target version of the endpoint.
static PROPERTY_INJECTION_ID🔹	`string`	Uniquely identifies this class.

agentRuntimeArn🔹

Type: string

The ARN of the agent runtime associated with this endpoint.

agentRuntimeEndpointArn🔹

Type: string

The ARN of the agent runtime endpoint.

agentRuntimeId🔹

Type: string

The ID of the agent runtime associated with this endpoint.

agentRuntimeVersion🔹

Type: string

The version of the agent runtime used by this endpoint.

endpointId🔹

Type: string

The unique identifier of the runtime endpoint.

endpointName🔹

Type: string

The name of the endpoint.

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.

node🔹

Type: Node

The tree node.

stack🔹

Type: Stack

The stack in which this resource is defined.

createdAt?🔹

Type: string (optional)

The timestamp when the endpoint was created.

description?🔹

Type: string (optional)

Optional description for the endpoint.

lastUpdatedAt?🔹

Type: string (optional)

When this endpoint was last updated.

liveVersion?🔹

Type: string (optional)

The live version of the endpoint.

status?🔹

Type: string (optional)

The status of the endpoint.

targetVersion?🔹

Type: string (optional)

The target version of the endpoint.

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromRuntimeEndpointAttributes(scope, id, attrs)🔹	Import an existing Agent Runtime Endpoint using attributes This allows you to reference an Agent Runtime Endpoint that was created outside of CDK.

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

toString()🔹

public toString(): string

Returns

string

Returns a string representation of this construct.

static fromRuntimeEndpointAttributes(scope, id, attrs)🔹

public static fromRuntimeEndpointAttributes(scope: Construct, id: string, attrs: RuntimeEndpointAttributes): IRuntimeEndpoint

Parameters

scope Construct — The construct scope.
id string — The construct id.
attrs RuntimeEndpointAttributes — The attributes of the existing Agent Runtime Endpoint.

Returns

IRuntimeEndpoint

Import an existing Agent Runtime Endpoint using attributes This allows you to reference an Agent Runtime Endpoint that was created outside of CDK.