Class CfnOnlineEvaluationConfigProps

Properties for defining a CfnOnlineEvaluationConfig.

Inheritance

object

CfnOnlineEvaluationConfigProps

Implements

ICfnOnlineEvaluationConfigProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.BedrockAgentCore

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnOnlineEvaluationConfigProps : ICfnOnlineEvaluationConfigProps

Syntax (vb)

Public Class CfnOnlineEvaluationConfigProps Implements ICfnOnlineEvaluationConfigProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html

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.AWS.BedrockAgentCore;

             var cfnOnlineEvaluationConfigProps = new CfnOnlineEvaluationConfigProps {
                 DataSourceConfig = new DataSourceConfigProperty {
                     CloudWatchLogs = new CloudWatchLogsInputConfigProperty {
                         LogGroupNames = new [] { "logGroupNames" },
                         ServiceNames = new [] { "serviceNames" }
                     }
                 },
                 EvaluationExecutionRoleArn = "evaluationExecutionRoleArn",
                 OnlineEvaluationConfigName = "onlineEvaluationConfigName",
                 Rule = new RuleProperty {
                     SamplingConfig = new SamplingConfigProperty {
                         SamplingPercentage = 123
                     },

                     // the properties below are optional
                     Filters = new [] { new FilterProperty {
                         Key = "key",
                         Operator = "operator",
                         Value = new FilterValueProperty {
                             BooleanValue = false,
                             DoubleValue = 123,
                             StringValue = "stringValue"
                         }
                     } },
                     SessionConfig = new SessionConfigProperty {
                         SessionTimeoutMinutes = 123
                     }
                 },

                 // the properties below are optional
                 ClusteringConfig = new ClusteringConfigProperty {
                     Frequencies = new [] { "frequencies" }
                 },
                 Description = "description",
                 Evaluators = new [] { new EvaluatorReferenceProperty {
                     EvaluatorId = "evaluatorId"
                 } },
                 ExecutionStatus = "executionStatus",
                 Insights = new [] { new InsightProperty {
                     InsightId = "insightId"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnOnlineEvaluationConfigProps()

Properties for defining a CfnOnlineEvaluationConfig.

Properties

ClusteringConfig	The configuration for clustering analysis of evaluation results.
DataSourceConfig	The configuration that specifies where to read agent traces for online evaluation.
Description	The description of the online evaluation configuration.
EvaluationExecutionRoleArn	The Amazon Resource Name (ARN) of the IAM role that grants permissions for evaluation.
Evaluators	The list of evaluators to apply during online evaluation.
ExecutionStatus	Properties for defining a `CfnOnlineEvaluationConfig`.
Insights	The list of insights to enable for failure analysis.
OnlineEvaluationConfigName	The name of the online evaluation configuration.
Rule	The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings.
Tags	A list of tags to assign to the online evaluation configuration.

Constructors

CfnOnlineEvaluationConfigProps()

Properties for defining a CfnOnlineEvaluationConfig.

public CfnOnlineEvaluationConfigProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html

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.AWS.BedrockAgentCore;

             var cfnOnlineEvaluationConfigProps = new CfnOnlineEvaluationConfigProps {
                 DataSourceConfig = new DataSourceConfigProperty {
                     CloudWatchLogs = new CloudWatchLogsInputConfigProperty {
                         LogGroupNames = new [] { "logGroupNames" },
                         ServiceNames = new [] { "serviceNames" }
                     }
                 },
                 EvaluationExecutionRoleArn = "evaluationExecutionRoleArn",
                 OnlineEvaluationConfigName = "onlineEvaluationConfigName",
                 Rule = new RuleProperty {
                     SamplingConfig = new SamplingConfigProperty {
                         SamplingPercentage = 123
                     },

                     // the properties below are optional
                     Filters = new [] { new FilterProperty {
                         Key = "key",
                         Operator = "operator",
                         Value = new FilterValueProperty {
                             BooleanValue = false,
                             DoubleValue = 123,
                             StringValue = "stringValue"
                         }
                     } },
                     SessionConfig = new SessionConfigProperty {
                         SessionTimeoutMinutes = 123
                     }
                 },

                 // the properties below are optional
                 ClusteringConfig = new ClusteringConfigProperty {
                     Frequencies = new [] { "frequencies" }
                 },
                 Description = "description",
                 Evaluators = new [] { new EvaluatorReferenceProperty {
                     EvaluatorId = "evaluatorId"
                 } },
                 ExecutionStatus = "executionStatus",
                 Insights = new [] { new InsightProperty {
                     InsightId = "insightId"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ClusteringConfig

The configuration for clustering analysis of evaluation results.

public object? ClusteringConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-clusteringconfig

Type union: either IResolvable or CfnOnlineEvaluationConfig.IClusteringConfigProperty

DataSourceConfig

The configuration that specifies where to read agent traces for online evaluation.

public object DataSourceConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig

Type union: either IResolvable or CfnOnlineEvaluationConfig.IDataSourceConfigProperty

Description

The description of the online evaluation configuration.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-description

EvaluationExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role that grants permissions for evaluation.

public string EvaluationExecutionRoleArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-evaluationexecutionrolearn

Evaluators

The list of evaluators to apply during online evaluation.

public object? Evaluators { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-evaluators

Type union: either IResolvable or (either IResolvable or CfnOnlineEvaluationConfig.IEvaluatorReferenceProperty)[]

ExecutionStatus

Properties for defining a CfnOnlineEvaluationConfig.

public string? ExecutionStatus { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-executionstatus

Insights

The list of insights to enable for failure analysis.

public object? Insights { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-insights

Type union: either IResolvable or (either IResolvable or CfnOnlineEvaluationConfig.IInsightProperty)[]

OnlineEvaluationConfigName

The name of the online evaluation configuration.

public string OnlineEvaluationConfigName { get; set; }

Property Value

string

Remarks

Must be unique within your account.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-onlineevaluationconfigname

Rule

The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings.

public object Rule { get; set; }