Package software.amazon.awscdk.services.bedrockagentcore

Interface OnlineEvaluationBaseProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
OnlineEvaluationConfigProps
All Known Implementing Classes:
OnlineEvaluationBaseProps.Jsii$Proxy, OnlineEvaluationConfigProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.489Z") @Stability(Stable) public interface OnlineEvaluationBaseProps extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.*;
 import software.amazon.awscdk.services.bedrockagentcore.*;
 import software.amazon.awscdk.services.iam.*;
 ExecutionStatus executionStatus;
 FilterOperator filterOperator;
 FilterValue filterValue;
 Role role;
 OnlineEvaluationBaseProps onlineEvaluationBaseProps = OnlineEvaluationBaseProps.builder()
         .onlineEvaluationConfigName("onlineEvaluationConfigName")
         // the properties below are optional
         .description("description")
         .executionRole(role)
         .executionStatus(executionStatus)
         .filters(List.of(FilterConfig.builder()
                 .key("key")
                 .operator(filterOperator)
                 .value(filterValue)
                 .build()))
         .samplingPercentage(123)
         .sessionTimeout(Duration.minutes(30))
         .build();

  • Method Details

    • getOnlineEvaluationConfigName

      @Stability(Stable) @NotNull String getOnlineEvaluationConfigName()
      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.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the online evaluation configuration.

      Default: - No description

    • getExecutionRole

      @Stability(Stable) @Nullable default IRole getExecutionRole()
      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.

      Default: - A new role will be created

    • getExecutionStatus

      @Stability(Stable) @Nullable default ExecutionStatus getExecutionStatus()
      The execution status of the online evaluation configuration.

      Controls whether the evaluation actively processes agent traces.

      Default: ExecutionStatus.ENABLED

    • getFilters

      @Stability(Stable) @Nullable default List<FilterConfig> getFilters()
      The list of filters that determine which agent traces should be evaluated.

      Default: - No filters (evaluate all sampled traces)

    • getSamplingPercentage

      @Stability(Stable) @Nullable default Number getSamplingPercentage()
      The percentage of agent traces to sample for evaluation.

      Default: 10

    • getSessionTimeout

      @Stability(Stable) @Nullable default Duration getSessionTimeout()
      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).

      Default: Duration.minutes(15)

    • builder

      @Stability(Stable) static OnlineEvaluationBaseProps.Builder builder()
      Returns:
      a OnlineEvaluationBaseProps.Builder of OnlineEvaluationBaseProps