CfnOnlineEvaluationConfigPropsMixin

class aws_cdk.mixins_preview.aws_bedrockagentcore.mixins.CfnOnlineEvaluationConfigPropsMixin(props, *, strategy=None)

Bases: Mixin

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
Mixin:: true
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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_online_evaluation_config_props_mixin = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin(bedrockagentcore_mixins.CfnOnlineEvaluationConfigMixinProps(
    data_source_config=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.DataSourceConfigProperty(
        cloud_watch_logs=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.CloudWatchLogsInputConfigProperty(
            log_group_names=["logGroupNames"],
            service_names=["serviceNames"]
        )
    ),
    description="description",
    evaluation_execution_role_arn="evaluationExecutionRoleArn",
    evaluators=[bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.EvaluatorReferenceProperty(
        evaluator_id="evaluatorId"
    )],
    online_evaluation_config_name="onlineEvaluationConfigName",
    rule=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.RuleProperty(
        filters=[bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.FilterProperty(
            key="key",
            operator="operator",
            value=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.FilterValueProperty(
                boolean_value=False,
                double_value=123,
                string_value="stringValue"
            )
        )],
        sampling_config=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.SamplingConfigProperty(
            sampling_percentage=123
        ),
        session_config=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.SessionConfigProperty(
            session_timeout_minutes=123
        )
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::BedrockAgentCore::OnlineEvaluationConfig.

Parameters:

props (Union[CfnOnlineEvaluationConfigMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['dataSourceConfig', 'description', 'evaluationExecutionRoleArn', 'evaluators', 'onlineEvaluationConfigName', 'rule', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

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

CloudWatchLogsInputConfigProperty

class CfnOnlineEvaluationConfigPropsMixin.CloudWatchLogsInputConfigProperty(*, log_group_names=None, service_names=None)

Bases: object

The configuration for reading agent traces from CloudWatch logs.

Parameters:

log_group_names (Optional[Sequence[str]]) – The list of CloudWatch log group names to monitor for agent traces.
service_names (Optional[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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

cloud_watch_logs_input_config_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

cloud_watch_output_config_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.DataSourceConfigProperty(*, cloud_watch_logs=None)

Bases: object

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

Parameters:: cloud_watch_logs (Union[IResolvable, CloudWatchLogsInputConfigProperty, Dict[str, Any], None]) – 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

data_source_config_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.DataSourceConfigProperty(
    cloud_watch_logs=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.EvaluatorReferenceProperty(*, evaluator_id=None)

Bases: object

The reference to an evaluator used in online evaluation configurations.

Parameters:: evaluator_id (Optional[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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

evaluator_reference_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.FilterProperty(*, key=None, operator=None, value=None)

Bases: object

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

Parameters:

key (Optional[str]) – The key or field name to filter on within the agent trace data.
operator (Optional[str]) – The comparison operator to use for filtering.
value (Union[IResolvable, FilterValueProperty, Dict[str, Any], None]) – 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

filter_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.FilterProperty(
    key="key",
    operator="operator",
    value=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

filter_value_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

output_config_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.OutputConfigProperty(
    cloud_watch_config=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.RuleProperty(*, filters=None, sampling_config=None, session_config=None)

Bases: object

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

Parameters:

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.
sampling_config (Union[IResolvable, SamplingConfigProperty, Dict[str, Any], None]) – The configuration that controls what percentage of agent traces are sampled for 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

rule_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.RuleProperty(
    filters=[bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.FilterProperty(
        key="key",
        operator="operator",
        value=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.FilterValueProperty(
            boolean_value=False,
            double_value=123,
            string_value="stringValue"
        )
    )],
    sampling_config=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.SamplingConfigProperty(
        sampling_percentage=123
    ),
    session_config=bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.SamplingConfigProperty(*, sampling_percentage=None)

Bases: object

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

Parameters:: sampling_percentage (Union[int, float, None]) – 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

sampling_config_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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 CfnOnlineEvaluationConfigPropsMixin.SessionConfigProperty(*, session_timeout_minutes=None)

Bases: object

The configuration that defines how agent sessions are detected.

Parameters:: session_timeout_minutes (Union[int, float, None]) – 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

session_config_property = bedrockagentcore_mixins.CfnOnlineEvaluationConfigPropsMixin.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