Class: AWSCDK::BedrockAgentCore::EvaluatorBase

Inherits:
Resource
  • Object
show all
Includes:
IEvaluator
Defined in:
bedrock_agent_core/evaluator_base.rb

Overview

Abstract base class for Evaluator.

Contains methods and attributes valid for evaluators either created with CDK or imported.

Direct Known Subclasses

Evaluator

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ EvaluatorBase

Returns a new instance of EvaluatorBase.

Parameters:



14
15
16
17
18
19
20
 
# File 'bedrock_agent_core/evaluator_base.rb', line 14

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ResourceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvdXJjZVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'bedrock_agent_core/evaluator_base.rb', line 22

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 },
    :evaluator_arn => { kind: :property, name: "evaluatorArn", is_optional: false },
    :evaluator_id => { kind: :property, name: "evaluatorId", is_optional: false },
    :evaluator_name => { kind: :property, name: "evaluatorName", is_optional: false },
    :evaluator_ref => { kind: :property, name: "evaluatorRef", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", 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

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:



171
172
173
174
 
# File 'bedrock_agent_core/evaluator_base.rb', line 171

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:



188
189
190
191
 
# File 'bedrock_agent_core/evaluator_base.rb', line 188

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 evaluator was created.

Returns:

  • (String, nil) 


120
121
122
 
# File 'bedrock_agent_core/evaluator_base.rb', line 120

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:



64
65
66
 
# File 'bedrock_agent_core/evaluator_base.rb', line 64

def env()
  jsii_get_property("env")
end

#evaluator_arn ⇒ String

The ARN of the evaluator.

Returns:

  • (String) 


92
93
94
 
# File 'bedrock_agent_core/evaluator_base.rb', line 92

def evaluator_arn()
  jsii_get_property("evaluatorArn")
end

#evaluator_id ⇒ String

The unique identifier of the evaluator.

Returns:

  • (String) 


99
100
101
 
# File 'bedrock_agent_core/evaluator_base.rb', line 99

def evaluator_id()
  jsii_get_property("evaluatorId")
end

#evaluator_name ⇒ String

The name of the evaluator.

Returns:

  • (String) 


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

def evaluator_name()
  jsii_get_property("evaluatorName")
end

#evaluator_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::EvaluatorReference

A reference to this Evaluator resource.

Returns:



113
114
115
 
# File 'bedrock_agent_core/evaluator_base.rb', line 113

def evaluator_ref()
  jsii_get_property("evaluatorRef")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


194
195
196
 
# File 'bedrock_agent_core/evaluator_base.rb', line 194

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) 


208
209
210
211
212
213
 
# File 'bedrock_agent_core/evaluator_base.rb', line 208

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) 


223
224
225
226
 
# File 'bedrock_agent_core/evaluator_base.rb', line 223

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:



235
236
237
238
239
240
241
 
# File 'bedrock_agent_core/evaluator_base.rb', line 235

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


49
50
51
 
# File 'bedrock_agent_core/evaluator_base.rb', line 49

def node()
  jsii_get_property("node")
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) 


78
79
80
 
# File 'bedrock_agent_core/evaluator_base.rb', line 78

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



85
86
87
 
# File 'bedrock_agent_core/evaluator_base.rb', line 85

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The lifecycle status of the evaluator (CREATING, ACTIVE, FAILED, DELETING).

Returns:

  • (String, nil) 


127
128
129
 
# File 'bedrock_agent_core/evaluator_base.rb', line 127

def status()
  jsii_get_property("status")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


141
142
143
 
# File 'bedrock_agent_core/evaluator_base.rb', line 141

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

#updated_at ⇒ String?

The timestamp when the evaluator was last updated.

Returns:

  • (String, nil) 


134
135
136
 
# File 'bedrock_agent_core/evaluator_base.rb', line 134

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) 


154
155
156
157
158
159
 
# File 'bedrock_agent_core/evaluator_base.rb', line 154

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