Interface IOnlineEvaluationBaseProps
Base properties for creating an OnlineEvaluationConfig.
Namespace: Amazon.CDK.AWS.BedrockAgentCore
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IOnlineEvaluationBasePropsSyntax (vb)
Public Interface IOnlineEvaluationBasePropsRemarks
The actual OnlineEvaluationProps is defined in online-evaluation-config.ts to avoid circular dependencies.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.BedrockAgentCore;
using Amazon.CDK.AWS.IAM;
ExecutionStatus executionStatus;
FilterOperator filterOperator;
FilterValue filterValue;
Role role;
var onlineEvaluationBaseProps = new OnlineEvaluationBaseProps {
OnlineEvaluationConfigName = "onlineEvaluationConfigName",
// the properties below are optional
Description = "description",
ExecutionRole = role,
ExecutionStatus = executionStatus,
Filters = new [] { new FilterConfig {
Key = "key",
Operator = filterOperator,
Value = filterValue
} },
SamplingPercentage = 123,
SessionTimeout = Duration.Minutes(30)
};Synopsis
Properties
| Description | The description of the online evaluation configuration. |
| ExecutionRole | The IAM role that provides permissions for the evaluation to access AWS services. |
| ExecutionStatus | The execution status of the online evaluation configuration. |
| Filters | The list of filters that determine which agent traces should be evaluated. |
| OnlineEvaluationConfigName | The name of the online evaluation configuration. |
| SamplingPercentage | The percentage of agent traces to sample for evaluation. |
| SessionTimeout | The duration of inactivity after which an agent session is considered complete and ready for evaluation. |
Properties
Description
The description of the online evaluation configuration.
string? Description { get; }Property Value
Remarks
Default: - No description
MaxLength: 200
ExecutionRole
The IAM role that provides permissions for the evaluation to access AWS services.
IRole? ExecutionRole { get; }Property Value
Remarks
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.
Default: - A new role will be created
ExecutionStatus
The execution status of the online evaluation configuration.
ExecutionStatus? ExecutionStatus { get; }Property Value
Remarks
Controls whether the evaluation actively processes agent traces.
Default: ExecutionStatus.ENABLED
Filters
The list of filters that determine which agent traces should be evaluated.
IFilterConfig[]? Filters { get; }Property Value
Remarks
Default: - No filters (evaluate all sampled traces)
Maximum: 5
OnlineEvaluationConfigName
The name of the online evaluation configuration.
string OnlineEvaluationConfigName { get; }Property Value
Remarks
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.
Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$
SamplingPercentage
The percentage of agent traces to sample for evaluation.
double? SamplingPercentage { get; }Property Value
Remarks
Default: 10
Maximum: 100
Minimum: 0.01
SessionTimeout
The duration of inactivity after which an agent session is considered complete and ready for evaluation.
Duration? SessionTimeout { get; }Property Value
Remarks
Must be between 1 minute and 1440 minutes (24 hours).
Default: Duration.minutes(15)