CfnOnlineEvaluationConfig

class aws_cdk.aws_bedrockagentcore.CfnOnlineEvaluationConfig(scope, id, *, data_source_config, evaluation_execution_role_arn, evaluators, online_evaluation_config_name, rule, description=None, tags=None)

Bases: CfnResource

Resource Type definition for AWS::BedrockAgentCore::OnlineEvaluationConfig - Creates an online evaluation configuration for continuous monitoring of agent performance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html
CloudformationResource:: AWS::BedrockAgentCore::OnlineEvaluationConfig
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cfn_online_evaluation_config = bedrockagentcore.CfnOnlineEvaluationConfig(self, "MyCfnOnlineEvaluationConfig",
    data_source_config=bedrockagentcore.CfnOnlineEvaluationConfig.DataSourceConfigProperty(
        cloud_watch_logs=bedrockagentcore.CfnOnlineEvaluationConfig.CloudWatchLogsInputConfigProperty(
            log_group_names=["logGroupNames"],
            service_names=["serviceNames"]
        )
    ),
    evaluation_execution_role_arn="evaluationExecutionRoleArn",
    evaluators=[bedrockagentcore.CfnOnlineEvaluationConfig.EvaluatorReferenceProperty(
        evaluator_id="evaluatorId"
    )],
    online_evaluation_config_name="onlineEvaluationConfigName",
    rule=bedrockagentcore.CfnOnlineEvaluationConfig.RuleProperty(
        sampling_config=bedrockagentcore.CfnOnlineEvaluationConfig.SamplingConfigProperty(
            sampling_percentage=123
        ),

        # the properties below are optional
        filters=[bedrockagentcore.CfnOnlineEvaluationConfig.FilterProperty(
            key="key",
            operator="operator",
            value=bedrockagentcore.CfnOnlineEvaluationConfig.FilterValueProperty(
                boolean_value=False,
                double_value=123,
                string_value="stringValue"
            )
        )],
        session_config=bedrockagentcore.CfnOnlineEvaluationConfig.SessionConfigProperty(
            session_timeout_minutes=123
        )
    ),

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::BedrockAgentCore::OnlineEvaluationConfig.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
data_source_config (Union[IResolvable, DataSourceConfigProperty, Dict[str, Any]]) – The configuration that specifies where to read agent traces for online evaluation.
evaluation_execution_role_arn (str) – The Amazon Resource Name (ARN) of the IAM role that grants permissions for evaluation.
evaluators (Union[IResolvable, Sequence[Union[IResolvable, EvaluatorReferenceProperty, Dict[str, Any]]]]) – The list of evaluators to apply during online evaluation.
online_evaluation_config_name (str) – The name of the online evaluation configuration. Must be unique within your account.
rule (Union[IResolvable, RuleProperty, Dict[str, Any]]) – The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings.
description (Optional[str]) – The description of the online evaluation configuration.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to assign to the online evaluation configuration.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::BedrockAgentCore::OnlineEvaluationConfig'

attr_created_at

The timestamp when the online evaluation configuration was created.

CloudformationAttribute:: CreatedAt

attr_execution_status

ExecutionStatus

Type:: cloudformationAttribute

attr_online_evaluation_config_arn

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

CloudformationAttribute:: OnlineEvaluationConfigArn

attr_online_evaluation_config_id

The unique identifier of the online evaluation configuration.

CloudformationAttribute:: OnlineEvaluationConfigId

attr_output_config

The configuration that specifies where evaluation results should be written.

CloudformationAttribute:: OutputConfig

attr_status

Status

Type:: cloudformationAttribute

attr_updated_at

The timestamp when the online evaluation configuration was last updated.

CloudformationAttribute:: UpdatedAt

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

description: The description of the online evaluation configuration.

env

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

evaluators: The list of evaluators to apply during online evaluation.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

online_evaluation_config_name: The name of the online evaluation configuration.

online_evaluation_config_ref: A reference to a OnlineEvaluationConfig resource.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: A list of tags to assign to the online evaluation configuration.

Static Methods

classmethod arn_for_online_evaluation_config(resource)

Parameters:: resource (IOnlineEvaluationConfigRef)
Return type:: str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_online_evaluation_config(x)

Checks whether the given object is a CfnOnlineEvaluationConfig.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

CloudWatchLogsInputConfigProperty

class CfnOnlineEvaluationConfig.CloudWatchLogsInputConfigProperty(*, log_group_names, service_names)

Bases: object

The configuration for reading agent traces from CloudWatch logs.

Parameters:

log_group_names (Sequence[str]) – The list of CloudWatch log group names to monitor for agent traces.
service_names (Sequence[str]) – The list of service names to filter traces within the specified log groups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cloud_watch_logs_input_config_property = bedrockagentcore.CfnOnlineEvaluationConfig.CloudWatchLogsInputConfigProperty(
    log_group_names=["logGroupNames"],
    service_names=["serviceNames"]
)

Attributes

log_group_names

The list of CloudWatch log group names to monitor for agent traces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-loggroupnames

service_names

The list of service names to filter traces within the specified log groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-servicenames

CloudWatchOutputConfigProperty

class CfnOnlineEvaluationConfig.CloudWatchOutputConfigProperty(*, log_group_name=None)

Bases: object

The CloudWatch configuration for writing evaluation results.

Parameters:: log_group_name (Optional[str]) – The CloudWatch log group name for evaluation results.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cloud_watch_output_config_property = bedrockagentcore.CfnOnlineEvaluationConfig.CloudWatchOutputConfigProperty(
    log_group_name="logGroupName"
)

Attributes

log_group_name

The CloudWatch log group name for evaluation results.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-loggroupname

DataSourceConfigProperty

class CfnOnlineEvaluationConfig.DataSourceConfigProperty(*, cloud_watch_logs)

Bases: object

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

Parameters:: cloud_watch_logs (Union[IResolvable, CloudWatchLogsInputConfigProperty, Dict[str, Any]]) – The configuration for reading agent traces from CloudWatch logs.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

data_source_config_property = bedrockagentcore.CfnOnlineEvaluationConfig.DataSourceConfigProperty(
    cloud_watch_logs=bedrockagentcore.CfnOnlineEvaluationConfig.CloudWatchLogsInputConfigProperty(
        log_group_names=["logGroupNames"],
        service_names=["serviceNames"]
    )
)

Attributes

cloud_watch_logs

The configuration for reading agent traces from CloudWatch logs.

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

EvaluatorReferenceProperty

class CfnOnlineEvaluationConfig.EvaluatorReferenceProperty(*, evaluator_id)

Bases: object

The reference to an evaluator used in online evaluation configurations.

Parameters:: evaluator_id (str) – The unique identifier of the evaluator.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

evaluator_reference_property = bedrockagentcore.CfnOnlineEvaluationConfig.EvaluatorReferenceProperty(
    evaluator_id="evaluatorId"
)

Attributes

evaluator_id

The unique identifier of the evaluator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference.html#cfn-bedrockagentcore-onlineevaluationconfig-evaluatorreference-evaluatorid

FilterProperty

class CfnOnlineEvaluationConfig.FilterProperty(*, key, operator, value)

Bases: object

The filter that applies conditions to agent traces during online evaluation.

Parameters:

key (str) – The key or field name to filter on within the agent trace data.
operator (str) – The comparison operator to use for filtering.
value (Union[IResolvable, FilterValueProperty, Dict[str, Any]]) – The value used in filter comparisons.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

filter_property = bedrockagentcore.CfnOnlineEvaluationConfig.FilterProperty(
    key="key",
    operator="operator",
    value=bedrockagentcore.CfnOnlineEvaluationConfig.FilterValueProperty(
        boolean_value=False,
        double_value=123,
        string_value="stringValue"
    )
)

Attributes

key

The key or field name to filter on within the agent trace data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filter.html#cfn-bedrockagentcore-onlineevaluationconfig-filter-key

operator

The comparison operator to use for filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filter.html#cfn-bedrockagentcore-onlineevaluationconfig-filter-operator

value

The value used in filter comparisons.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filter.html#cfn-bedrockagentcore-onlineevaluationconfig-filter-value

FilterValueProperty

class CfnOnlineEvaluationConfig.FilterValueProperty(*, boolean_value=None, double_value=None, string_value=None)

Bases: object

The value used in filter comparisons.

Parameters:

boolean_value (Union[bool, IResolvable, None]) – The boolean value for true/false filtering conditions.
double_value (Union[int, float, None]) – The numeric value for numerical filtering.
string_value (Optional[str]) – The string value for text-based filtering.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

filter_value_property = bedrockagentcore.CfnOnlineEvaluationConfig.FilterValueProperty(
    boolean_value=False,
    double_value=123,
    string_value="stringValue"
)

Attributes

boolean_value

The boolean value for true/false filtering conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.html#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-booleanvalue

double_value

The numeric value for numerical filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.html#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-doublevalue

string_value

The string value for text-based filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.html#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-stringvalue

OutputConfigProperty

class CfnOnlineEvaluationConfig.OutputConfigProperty(*, cloud_watch_config=None)

Bases: object

The configuration that specifies where evaluation results should be written.

Parameters:: cloud_watch_config (Union[IResolvable, CloudWatchOutputConfigProperty, Dict[str, Any], None]) – The CloudWatch configuration for writing evaluation results.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

output_config_property = bedrockagentcore.CfnOnlineEvaluationConfig.OutputConfigProperty(
    cloud_watch_config=bedrockagentcore.CfnOnlineEvaluationConfig.CloudWatchOutputConfigProperty(
        log_group_name="logGroupName"
    )
)

Attributes

cloud_watch_config

The CloudWatch configuration for writing evaluation results.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-outputconfig-cloudwatchconfig

RuleProperty

class CfnOnlineEvaluationConfig.RuleProperty(*, sampling_config, filters=None, session_config=None)

Bases: object

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

Parameters:

sampling_config (Union[IResolvable, SamplingConfigProperty, Dict[str, Any]]) – The configuration that controls what percentage of agent traces are sampled for evaluation.
filters (Union[IResolvable, Sequence[Union[IResolvable, FilterProperty, Dict[str, Any]]], None]) – The list of filters that determine which agent traces should be included in the evaluation.
session_config (Union[IResolvable, SessionConfigProperty, Dict[str, Any], None]) – The configuration that defines how agent sessions are detected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-rule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

rule_property = bedrockagentcore.CfnOnlineEvaluationConfig.RuleProperty(
    sampling_config=bedrockagentcore.CfnOnlineEvaluationConfig.SamplingConfigProperty(
        sampling_percentage=123
    ),

    # the properties below are optional
    filters=[bedrockagentcore.CfnOnlineEvaluationConfig.FilterProperty(
        key="key",
        operator="operator",
        value=bedrockagentcore.CfnOnlineEvaluationConfig.FilterValueProperty(
            boolean_value=False,
            double_value=123,
            string_value="stringValue"
        )
    )],
    session_config=bedrockagentcore.CfnOnlineEvaluationConfig.SessionConfigProperty(
        session_timeout_minutes=123
    )
)

Attributes

filters

The list of filters that determine which agent traces should be included in the evaluation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-rule.html#cfn-bedrockagentcore-onlineevaluationconfig-rule-filters

sampling_config

The configuration that controls what percentage of agent traces are sampled for evaluation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-rule.html#cfn-bedrockagentcore-onlineevaluationconfig-rule-samplingconfig

session_config

The configuration that defines how agent sessions are detected.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-rule.html#cfn-bedrockagentcore-onlineevaluationconfig-rule-sessionconfig

SamplingConfigProperty

class CfnOnlineEvaluationConfig.SamplingConfigProperty(*, sampling_percentage)

Bases: object

The configuration that controls what percentage of agent traces are sampled for evaluation.

Parameters:: sampling_percentage (Union[int, float]) – The percentage of agent traces to sample for evaluation.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

sampling_config_property = bedrockagentcore.CfnOnlineEvaluationConfig.SamplingConfigProperty(
    sampling_percentage=123
)

Attributes

sampling_percentage

The percentage of agent traces to sample for evaluation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-samplingconfig-samplingpercentage

SessionConfigProperty

class CfnOnlineEvaluationConfig.SessionConfigProperty(*, session_timeout_minutes)

Bases: object

The configuration that defines how agent sessions are detected.

Parameters:: session_timeout_minutes (Union[int, float]) – The number of minutes of inactivity after which an agent session is considered complete.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

session_config_property = bedrockagentcore.CfnOnlineEvaluationConfig.SessionConfigProperty(
    session_timeout_minutes=123
)

Attributes

session_timeout_minutes

The number of minutes of inactivity after which an agent session is considered complete.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-sessionconfig-sessiontimeoutminutes