2.253.1

interface OnlineEvaluationBaseProps 🔹

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

Base properties for creating an OnlineEvaluationConfig.

The actual OnlineEvaluationProps is defined in online-evaluation-config.ts to avoid circular dependencies.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const executionStatus: bedrock_agentcore_alpha.ExecutionStatus;
declare const filterOperator: bedrock_agentcore_alpha.FilterOperator;
declare const filterValue: bedrock_agentcore_alpha.FilterValue;
declare const role: iam.Role;
const onlineEvaluationBaseProps: bedrock_agentcore_alpha.OnlineEvaluationBaseProps = {
  onlineEvaluationConfigName: 'onlineEvaluationConfigName',

  // the properties below are optional
  description: 'description',
  executionRole: role,
  executionStatus: executionStatus,
  filters: [{
    key: 'key',
    operator: filterOperator,
    value: filterValue,
  }],
  samplingPercentage: 123,
  sessionTimeout: cdk.Duration.minutes(30),
};

Properties

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

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

← PreviousNext →