2.221.0

class Runtime (construct) 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Agentcore.Alpha.Runtime
Gogithub.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#Runtime
Javasoftware.amazon.awscdk.services.bedrock.agentcore.alpha.Runtime
Pythonaws_cdk.aws_bedrock_agentcore_alpha.Runtime
TypeScript (source)@aws-cdk/aws-bedrock-agentcore-alpha » Runtime

Implements IConstruct, IDependable, IResource, IBedrockAgentRuntime, IGrantable, IConnectable

Bedrock Agent Core Runtime Enables running containerized agents with specific network configurations, security settings, and runtime artifacts.

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

Example

const repository = new ecr.Repository(this, "TestRepository", {
  repositoryName: "test-agent-runtime",
});
const agentRuntimeArtifact = agentcore.AgentRuntimeArtifact.fromEcrRepository(repository, "v1.0.0");

const runtime = new agentcore.Runtime(this, "MyAgentRuntime", {
  runtimeName: "myAgent",
  agentRuntimeArtifact: agentRuntimeArtifact,
  authorizerConfiguration: agentcore.RuntimeAuthorizerConfiguration.usingOAuth(
    "https://github.com/.well-known/openid-configuration",
    "oauth_client_123",
  ),
});

Initializer

new Runtime(scope: Construct, id: string, props: RuntimeProps)

Parameters

Construct Props

NameTypeDescription
agentRuntimeArtifact🔹AgentRuntimeArtifactThe artifact configuration for the agent runtime Contains the container configuration with ECR URI.
runtimeName🔹stringThe name of the agent runtime 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}$.
authorizerConfiguration?🔹RuntimeAuthorizerConfigurationAuthorizer configuration for the agent runtime Use RuntimeAuthorizerConfiguration static methods to create the configuration.
description?🔹stringOptional description for the agent runtime.
environmentVariables?🔹{ [string]: string }Environment variables for the agent runtime - Maximum 50 environment variables - Key: Must be 1-100 characters, start with letter or underscore, contain only letters, numbers, and underscores - Value: Must be 0-2048 characters (per CloudFormation specification).
executionRole?🔹IRoleThe IAM role that provides permissions for the agent runtime If not provided, a role will be created automatically.
networkConfiguration?🔹RuntimeNetworkConfigurationNetwork configuration for the agent runtime.
protocolConfiguration?🔹ProtocolTypeProtocol configuration for the agent runtime.
tags?🔹{ [string]: string }Tags for the agent runtime A list of key:value pairs of tags to apply to this Runtime resource.

agentRuntimeArtifact🔹

Type: AgentRuntimeArtifact

The artifact configuration for the agent runtime Contains the container configuration with ECR URI.

runtimeName🔹

Type: string

The name of the agent runtime 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}$.

authorizerConfiguration?🔹

Type: RuntimeAuthorizerConfiguration (optional, default: RuntimeAuthorizerConfiguration.iam() (IAM authentication))

Authorizer configuration for the agent runtime Use RuntimeAuthorizerConfiguration static methods to create the configuration.

description?🔹

Type: string (optional, default: No description Length Minimum: 1 , Maximum: 1200)

Optional description for the agent runtime.

environmentVariables?🔹

Type: { [string]: string } (optional, default: No environment variables)

Environment variables for the agent runtime - Maximum 50 environment variables - Key: Must be 1-100 characters, start with letter or underscore, contain only letters, numbers, and underscores - Value: Must be 0-2048 characters (per CloudFormation specification).

executionRole?🔹

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

The IAM role that provides permissions for the agent runtime If not provided, a role will be created automatically.

networkConfiguration?🔹

Type: RuntimeNetworkConfiguration (optional, default: RuntimeNetworkConfiguration.usingPublicNetwork())

Network configuration for the agent runtime.

protocolConfiguration?🔹

Type: ProtocolType (optional, default: ProtocolType.HTTP)

Protocol configuration for the agent runtime.

tags?🔹

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

Tags for the agent runtime A list of key:value pairs of tags to apply to this Runtime resource.

Properties

NameTypeDescription
agentRuntimeArn🔹stringThe ARN of the agent runtime.
agentRuntimeArtifact🔹AgentRuntimeArtifactThe artifact configuration for the agent runtime.
agentRuntimeId🔹stringThe unique identifier of the agent runtime.
agentRuntimeName🔹stringThe name of the agent runtime.
connections🔹ConnectionsAn accessor for the Connections object that will fail if this Runtime does not have a VPC configured.
env🔹ResourceEnvironmentThe environment this resource belongs to.
grantPrincipal🔹IPrincipalThe principal to grant permissions to.
node🔹NodeThe tree node.
role🔹IRoleThe IAM role that provides permissions for the agent runtime.
stack🔹StackThe stack in which this resource is defined.
agentRuntimeVersion?🔹stringThe version of the agent runtime.
agentStatus?🔹stringThe status of the agent runtime.
createdAt?🔹stringThe timestamp when the agent runtime was created.
description?🔹stringOptional description for the agent runtime.
lastUpdatedAt?🔹stringThe timestamp when the agent runtime was last updated.
static PROPERTY_INJECTION_ID🔹stringUniquely identifies this class.

agentRuntimeArn🔹

Type: string

The ARN of the agent runtime.

agentRuntimeArtifact🔹

Type: AgentRuntimeArtifact

The artifact configuration for the agent runtime.

agentRuntimeId🔹

Type: string

The unique identifier of the agent runtime.

agentRuntimeName🔹

Type: string

The name of the agent runtime.

connections🔹

Type: Connections

An accessor for the Connections object that will fail if this Runtime 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.

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

node🔹

Type: Node

The tree node.

role🔹

Type: IRole

The IAM role that provides permissions for the agent runtime.

stack🔹

Type: Stack

The stack in which this resource is defined.

agentRuntimeVersion?🔹

Type: string (optional)

The version of the agent runtime.

agentStatus?🔹

Type: string (optional)

The status of the agent runtime.

createdAt?🔹

Type: string (optional)

The timestamp when the agent runtime was created.

description?🔹

Type: string (optional)

Optional description for the agent runtime.

lastUpdatedAt?🔹

Type: string (optional)

The timestamp when the agent runtime was last updated.

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

NameDescription
addEndpoint(endpointName, options?)🔹Add an endpoint to this runtime This is a convenience method that creates a RuntimeEndpoint associated with this runtime.
addToRolePolicy(statement)🔹Adds a policy statement to the runtime's execution role.
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
grant(actions, resources)🔹Grant the runtime specific actions on AWS resources.
grantInvoke(grantee)🔹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.
grantInvokeRuntime(grantee)🔹Permits an IAM principal to invoke this runtime Grants the bedrock-agentcore:InvokeAgentRuntime permission.
grantInvokeRuntimeForUser(grantee)🔹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.
metric(metricName, dimensions, props?)🔹Return the given named metric for this agent runtime.
metricInvocations(props?)🔹Return a metric containing the total number of invocations for this agent runtime.
metricInvocationsAggregated(props?)🔹Return a metric containing the total number of invocations across all resources.
metricLatency(props?)🔹Return a metric measuring the latency of requests for this agent runtime.
metricSessionCount(props?)🔹Return a metric containing the number of agent sessions for this agent runtime.
metricSessionsAggregated(props?)🔹Return a metric containing the total number of sessions across all resources.
metricSystemErrors(props?)🔹Return a metric containing the number of system errors for this agent runtime.
metricThrottles(props?)🔹Return a metric containing the number of throttled requests for this agent runtime.
metricTotalErrors(props?)🔹Return a metric containing the total number of errors (system + user) for this agent runtime.
metricUserErrors(props?)🔹Return a metric containing the number of user errors for this agent runtime.
toString()🔹Returns a string representation of this construct.
static fromAgentRuntimeAttributes(scope, id, attrs)🔹Import an existing Agent Runtime using attributes This allows you to reference an Agent Runtime that was created outside of CDK.

addEndpoint(endpointName, options?)🔹

public addEndpoint(endpointName: string, options?: AddEndpointOptions): RuntimeEndpoint

Parameters

  • endpointName string — The name of the endpoint.
  • options AddEndpointOptions — Optional configuration for the endpoint.

Returns

Add an endpoint to this runtime This is a convenience method that creates a RuntimeEndpoint associated with this runtime.

addToRolePolicy(statement)🔹

public addToRolePolicy(statement: PolicyStatement): IBedrockAgentRuntime

Parameters

Returns

Adds a policy statement to the runtime's execution role.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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, resources)🔹

public grant(actions: string[], resources: string[]): Grant

Parameters

  • actions string[] — The actions to grant.
  • resources string[] — The resource ARNs to grant access to.

Returns

Grant the runtime specific actions on AWS resources.

grantInvoke(grantee)🔹

public grantInvoke(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — The principal to grant access to.

Returns

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.

grantInvokeRuntime(grantee)🔹

public grantInvokeRuntime(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — The principal to grant access to.

Returns

Permits an IAM principal to invoke this runtime Grants the bedrock-agentcore:InvokeAgentRuntime permission.

grantInvokeRuntimeForUser(grantee)🔹

public grantInvokeRuntimeForUser(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — The principal to grant access to.

Returns

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.

metric(metricName, dimensions, props?)🔹

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

Parameters

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

Returns

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?)🔹

public metricInvocations(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the total number of invocations for this agent runtime.

metricInvocationsAggregated(props?)🔹

public metricInvocationsAggregated(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the total number of invocations across all resources.

metricLatency(props?)🔹

public metricLatency(props?: MetricOptions): Metric

Parameters

Returns

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?)🔹

public metricSessionCount(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the number of agent sessions for this agent runtime.

metricSessionsAggregated(props?)🔹

public metricSessionsAggregated(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the total number of sessions across all resources.

metricSystemErrors(props?)🔹

public metricSystemErrors(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the number of system errors for this agent runtime.

metricThrottles(props?)🔹

public metricThrottles(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the number of throttled requests for this agent runtime.

metricTotalErrors(props?)🔹

public metricTotalErrors(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the total number of errors (system + user) for this agent runtime.

metricUserErrors(props?)🔹

public metricUserErrors(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the number of user errors for this agent runtime.

toString()🔹

public toString(): string

Returns

  • string

Returns a string representation of this construct.

static fromAgentRuntimeAttributes(scope, id, attrs)🔹

public static fromAgentRuntimeAttributes(scope: Construct, id: string, attrs: AgentRuntimeAttributes): IBedrockAgentRuntime

Parameters

Returns

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

← PreviousNext →