Class: AWSCDK::BedrockAgentCore::OnlineEvaluationConfig

Inherits:
OnlineEvaluationBase
  • Object
show all
Defined in:
bedrock_agent_core/online_evaluation_config.rb

Overview

Online evaluation configuration for Amazon Bedrock AgentCore.

Enables continuous evaluation of agent performance using built-in or custom evaluators. Supports CloudWatch Logs and Agent Endpoint data sources.

Examples:

# Basic usage with built-in evaluators
evaluation = AWSCDK::BedrockAgentCore::OnlineEvaluationConfig.new(self, "MyEvaluation", {
    online_evaluation_config_name: "my_evaluation",
    evaluators: [
        AWSCDK::BedrockAgentCore::EvaluatorSelector.builtin(AWSCDK::BedrockAgentCore::BuiltinEvaluator.HELPFULNESS),
        AWSCDK::BedrockAgentCore::EvaluatorSelector.builtin(AWSCDK::BedrockAgentCore::BuiltinEvaluator.CORRECTNESS),
    ],
    data_source: AWSCDK::BedrockAgentCore::DataSourceConfig.from_cloud_watch_logs({
        log_group_names: ["/aws/bedrock-agentcore/my-agent"],
        service_names: ["my-agent.default"],
    }),
})

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ OnlineEvaluationConfig

Returns a new instance of OnlineEvaluationConfig.

Parameters:



28
29
30
31
32
33
34
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 28

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::OnlineEvaluationConfigProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5PbmxpbmVFdmFsdWF0aW9uQ29uZmlnUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_online_evaluation_config_arn(scope, id, online_evaluation_config_arn) ⇒ AWSCDK::BedrockAgentCore::IOnlineEvaluationConfig

Import an existing OnlineEvaluationConfig by its ARN.

Parameters:

  • scope (Constructs::Construct) —
    • The construct scope.
  • id (String) —
    • Construct identifier.
  • online_evaluation_config_arn (String) —
    • The configuration ARN to import.

Returns:



69
70
71
72
73
74
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 69

def self.from_online_evaluation_config_arn(scope, id, online_evaluation_config_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(online_evaluation_config_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onlineEvaluationConfigArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.OnlineEvaluationConfig", "fromOnlineEvaluationConfigArn", [scope, id, online_evaluation_config_arn])
end

.from_online_evaluation_config_attributes(scope, id, attrs) ⇒ AWSCDK::BedrockAgentCore::IOnlineEvaluationConfig

Import an existing OnlineEvaluationConfig from its attributes.

Parameters:

Returns:



82
83
84
85
86
87
88
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 82

def self.from_online_evaluation_config_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::OnlineEvaluationConfigAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5PbmxpbmVFdmFsdWF0aW9uQ29uZmlnQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.OnlineEvaluationConfig", "fromOnlineEvaluationConfigAttributes", [scope, id, attrs])
end

.from_online_evaluation_config_id(scope, id, online_evaluation_config_id) ⇒ AWSCDK::BedrockAgentCore::IOnlineEvaluationConfig

Import an existing OnlineEvaluationConfig by its ID.

Parameters:

  • scope (Constructs::Construct) —
    • The construct scope.
  • id (String) —
    • Construct identifier.
  • online_evaluation_config_id (String) —
    • The configuration ID to import.

Returns:



96
97
98
99
100
101
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 96

def self.from_online_evaluation_config_id(scope, id, online_evaluation_config_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(online_evaluation_config_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onlineEvaluationConfigId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.OnlineEvaluationConfig", "fromOnlineEvaluationConfigId", [scope, id, online_evaluation_config_id])
end

.jsii_overridable_methods ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 36

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :online_evaluation_config_arn => { kind: :property, name: "onlineEvaluationConfigArn", is_optional: false },
    :online_evaluation_config_id => { kind: :property, name: "onlineEvaluationConfigId", is_optional: false },
    :online_evaluation_config_name => { kind: :property, name: "onlineEvaluationConfigName", is_optional: false },
    :online_evaluation_config_ref => { kind: :property, name: "onlineEvaluationConfigRef", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", is_optional: true },
    :execution_role => { kind: :property, name: "executionRole", is_optional: true },
    :execution_status => { kind: :property, name: "executionStatus", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :updated_at => { kind: :property, name: "updatedAt", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


219
220
221
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 219

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_bedrockagentcore.OnlineEvaluationConfig", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



256
257
258
259
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 256

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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).

Parameters:



273
274
275
276
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 273

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#created_at ⇒ String?

The timestamp when the configuration was created.

Returns:

  • (String, nil) 


184
185
186
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 184

def created_at()
  jsii_get_property("createdAt")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



121
122
123
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 121

def env()
  jsii_get_property("env")
end

#execution_role ⇒ AWSCDK::IAM::IRole?

The IAM execution role for the evaluation.

Returns:



191
192
193
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 191

def execution_role()
  jsii_get_property("executionRole")
end

#execution_status ⇒ String?

The execution status of the evaluation (ENABLED or DISABLED).

Returns:

  • (String, nil) 


198
199
200
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 198

def execution_status()
  jsii_get_property("executionStatus")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


279
280
281
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 279

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


293
294
295
296
297
298
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 293

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


308
309
310
311
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 308

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —
    • The IAM principal to grant permissions to.
  • actions (Array<String>) —
    • The actions to grant.

Returns:



320
321
322
323
324
325
326
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 320

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



149
150
151
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 149

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 106

def node()
  jsii_get_property("node")
end

#online_evaluation_config_arn ⇒ String

The ARN of the online evaluation configuration.

Returns:

  • (String) 


156
157
158
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 156

def online_evaluation_config_arn()
  jsii_get_property("onlineEvaluationConfigArn")
end

#online_evaluation_config_id ⇒ String

The unique identifier of the online evaluation configuration.

Returns:

  • (String) 


163
164
165
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 163

def online_evaluation_config_id()
  jsii_get_property("onlineEvaluationConfigId")
end

#online_evaluation_config_name ⇒ String

The name of the online evaluation configuration.

Returns:

  • (String) 


170
171
172
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 170

def online_evaluation_config_name()
  jsii_get_property("onlineEvaluationConfigName")
end

#online_evaluation_config_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::OnlineEvaluationConfigReference

A reference to this OnlineEvaluationConfig resource.

Returns:



177
178
179
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 177

def online_evaluation_config_ref()
  jsii_get_property("onlineEvaluationConfigRef")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


135
136
137
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 135

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



142
143
144
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 142

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The lifecycle status of the configuration.

Returns:

  • (String, nil) 


205
206
207
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 205

def status()
  jsii_get_property("status")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


226
227
228
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 226

def to_string()
  jsii_call_method("toString", [])
end

#updated_at ⇒ String?

The timestamp when the configuration was last updated.

Returns:

  • (String, nil) 


212
213
214
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 212

def updated_at()
  jsii_get_property("updatedAt")
end

#with(*mixins) ⇒ Constructs::IConstruct

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 (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


239
240
241
242
243
244
 
# File 'bedrock_agent_core/online_evaluation_config.rb', line 239

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end