AWS::BedrockAgentCore::OnlineEvaluationConfig - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::BedrockAgentCore::OnlineEvaluationConfig

Specifies an online evaluation configuration for Amazon Bedrock AgentCore. An online evaluation configuration enables continuous monitoring and assessment of agent performance in production.

For more information, see Monitor agent performance with Amazon Bedrock AgentCore online evaluation.

See the Properties section below for descriptions of both the required and optional properties.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::BedrockAgentCore::OnlineEvaluationConfig",
  "Properties" : {
      "DataSourceConfig" : DataSourceConfig,
      "Description" : String,
      "EvaluationExecutionRoleArn" : String,
      "Evaluators" : [ EvaluatorReference, ... ],
      "ExecutionStatus" : String,
      "OnlineEvaluationConfigName" : String,
      "Rule" : Rule,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::BedrockAgentCore::OnlineEvaluationConfig
Properties:
  DataSourceConfig: 
    DataSourceConfig
  Description: String
  EvaluationExecutionRoleArn: String
  Evaluators: 
    - EvaluatorReference
  ExecutionStatus: String
  OnlineEvaluationConfigName: String
  Rule: 
    Rule
  Tags: 
    - Tag

Properties

DataSourceConfig

The data source configuration specifying CloudWatch log groups and service names to monitor.

Required: Yes

Type: DataSourceConfig

Update requires: No interruption

Description

The description of the online evaluation configuration.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: No interruption

EvaluationExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

Required: Yes

Type: String

Pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Evaluators

The list of evaluators applied during online evaluation.

Required: Yes

Type: Array of EvaluatorReference

Minimum: 1

Maximum: 10

Update requires: No interruption

ExecutionStatus

The execution status indicating whether the online evaluation is currently running.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

OnlineEvaluationConfigName

The name of the online evaluation configuration.

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$

Update requires: Replacement

Rule

The evaluation rule containing sampling configuration, filters, and session settings.

Required: Yes

Type: Rule

Update requires: No interruption

Tags

The tags for the online evaluation configuration.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier of the online evaluation configuration.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The timestamp when the online evaluation configuration was created.

OnlineEvaluationConfigArn

The Amazon Resource Name (ARN) of the online evaluation configuration.

OnlineEvaluationConfigId

The unique identifier of the online evaluation configuration.

Status

The current status of the online evaluation configuration.

UpdatedAt

The timestamp when the online evaluation configuration was last updated.