2.253.1

class OnlineEvaluationConfig (construct) 🔹

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IOnlineEvaluationConfig, IGrantable, IOnlineEvaluationConfigRef

Online evaluation configuration for Amazon Bedrock AgentCore.

Enables continuous evaluation of agent performance using built-in or custom evaluators. Supports CloudWatch Logs and Agent Endpoint data sources.

Example

// Basic usage with built-in evaluators
const evaluation = new agentcore.OnlineEvaluationConfig(this, 'MyEvaluation', {
  onlineEvaluationConfigName: 'my_evaluation',
  evaluators: [
    agentcore.EvaluatorReference.builtin(agentcore.BuiltinEvaluator.HELPFULNESS),
    agentcore.EvaluatorReference.builtin(agentcore.BuiltinEvaluator.CORRECTNESS),
  ],
  dataSource: agentcore.DataSourceConfig.fromCloudWatchLogs({
    logGroupNames: ['/aws/bedrock-agentcore/my-agent'],
    serviceNames: ['my-agent.default'],
  }),
});

Initializer

new OnlineEvaluationConfig(scope: Construct, id: string, props: OnlineEvaluationConfigProps)

Parameters

Construct Props

NameTypeDescription
dataSource🔹DataSourceConfigThe data source configuration that specifies where to read agent traces from.
evaluators🔹EvaluatorReference[]The list of evaluators to apply during online evaluation.
onlineEvaluationConfigName🔹stringThe name of the online evaluation configuration.
description?🔹stringThe description of the online evaluation configuration.
executionRole?🔹IRoleThe IAM role that provides permissions for the evaluation to access AWS services.
executionStatus?🔹ExecutionStatusThe execution status of the online evaluation configuration.
filters?🔹FilterConfig[]The list of filters that determine which agent traces should be evaluated.
samplingPercentage?🔹numberThe percentage of agent traces to sample for evaluation.
sessionTimeout?🔹DurationThe duration of inactivity after which an agent session is considered complete and ready for evaluation.

dataSource🔹

Type: DataSourceConfig

The data source configuration that specifies where to read agent traces from.

evaluators🔹

Type: EvaluatorReference[]

The list of evaluators to apply during online evaluation.

Can include both built-in evaluators and custom evaluators.

onlineEvaluationConfigName🔹

Type: string

The name of the online evaluation configuration.

Must be unique within your account. Valid characters are a-z, A-Z, 0-9, _ (underscore). Must start with a letter and can be up to 48 characters long.

description?🔹

Type: string (optional, default: No description)

The description of the online evaluation configuration.

executionRole?🔹

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

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

If not provided, a role will be created automatically with the required permissions including cross-region Bedrock model invocation (to support cross-region inference profiles). For strict cost controls or data residency compliance, provide a custom role with region-scoped permissions.

executionStatus?🔹

Type: ExecutionStatus (optional, default: ExecutionStatus.ENABLED)

The execution status of the online evaluation configuration.

Controls whether the evaluation actively processes agent traces.

filters?🔹

Type: FilterConfig[] (optional, default: No filters (evaluate all sampled traces))

The list of filters that determine which agent traces should be evaluated.

samplingPercentage?🔹

Type: number (optional, default: 10)

The percentage of agent traces to sample for evaluation.

sessionTimeout?🔹

Type: Duration (optional, default: Duration.minutes(15))

The duration of inactivity after which an agent session is considered complete and ready for evaluation.

Must be between 1 minute and 1440 minutes (24 hours).

Properties

NameTypeDescription
env🔹ResourceEnvironmentThe environment this resource belongs to.
grantPrincipal🔹IPrincipalThe principal to grant permissions to.
node🔹NodeThe tree node.
onlineEvaluationConfigArn🔹stringThe ARN of the online evaluation configuration.
onlineEvaluationConfigId🔹stringThe unique identifier of the online evaluation configuration.
onlineEvaluationConfigName🔹stringThe name of the online evaluation configuration.
onlineEvaluationConfigRef🔹OnlineEvaluationConfigReferenceA reference to this OnlineEvaluationConfig resource.
stack🔹StackThe stack in which this resource is defined.
createdAt?🔹stringThe timestamp when the configuration was created.
executionRole?🔹IRoleThe IAM execution role for the evaluation.
executionStatus?🔹stringThe execution status of the evaluation (ENABLED or DISABLED).
status?🔹stringThe lifecycle status of the configuration.
updatedAt?🔹stringThe timestamp when the configuration was last updated.
static PROPERTY_INJECTION_ID🔹stringUniquely identifies this class.

env🔹

Type: ResourceEnvironment

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.

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

node🔹

Type: Node

The tree node.

onlineEvaluationConfigArn🔹

Type: string

The ARN of the online evaluation configuration.

onlineEvaluationConfigId🔹

Type: string

The unique identifier of the online evaluation configuration.

onlineEvaluationConfigName🔹

Type: string

The name of the online evaluation configuration.

onlineEvaluationConfigRef🔹

Type: OnlineEvaluationConfigReference

A reference to this OnlineEvaluationConfig resource.

stack🔹

Type: Stack

The stack in which this resource is defined.

createdAt?🔹

Type: string (optional)

The timestamp when the configuration was created.

executionRole?🔹

Type: IRole (optional)

The IAM execution role for the evaluation.

executionStatus?🔹

Type: string (optional)

The execution status of the evaluation (ENABLED or DISABLED).

status?🔹

Type: string (optional)

The lifecycle status of the configuration.

updatedAt?🔹

Type: string (optional)

The timestamp when the configuration was last updated.

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹Grants IAM actions to the IAM Principal.
toString()🔹Returns a string representation of this construct.
with(...mixins)🔹Applies one or more mixins to this construct.
static fromOnlineEvaluationConfigArn(scope, id, onlineEvaluationConfigArn)🔹Import an existing OnlineEvaluationConfig by its ARN.
static fromOnlineEvaluationConfigAttributes(scope, id, attrs)🔹Import an existing OnlineEvaluationConfig from its attributes.
static fromOnlineEvaluationConfigId(scope, id, onlineEvaluationConfigId)🔹Import an existing OnlineEvaluationConfig by its ID.

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

Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

toString()🔹

public toString(): string

Returns

  • string

Returns a string representation of this construct.

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

Returns

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.

static fromOnlineEvaluationConfigArn(scope, id, onlineEvaluationConfigArn)🔹

public static fromOnlineEvaluationConfigArn(scope: Construct, id: string, onlineEvaluationConfigArn: string): IOnlineEvaluationConfig

Parameters

  • scope Construct — - The construct scope.
  • id string — - Construct identifier.
  • onlineEvaluationConfigArn string — - The configuration ARN to import.

Returns

Import an existing OnlineEvaluationConfig by its ARN.

static fromOnlineEvaluationConfigAttributes(scope, id, attrs)🔹

public static fromOnlineEvaluationConfigAttributes(scope: Construct, id: string, attrs: OnlineEvaluationConfigAttributes): IOnlineEvaluationConfig

Parameters

Returns

Import an existing OnlineEvaluationConfig from its attributes.

static fromOnlineEvaluationConfigId(scope, id, onlineEvaluationConfigId)🔹

public static fromOnlineEvaluationConfigId(scope: Construct, id: string, onlineEvaluationConfigId: string): IOnlineEvaluationConfig

Parameters

  • scope Construct — - The construct scope.
  • id string — - Construct identifier.
  • onlineEvaluationConfigId string — - The configuration ID to import.

Returns

Import an existing OnlineEvaluationConfig by its ID.

← PreviousNext →