Module: AWSCDK::BedrockAgentCore::IEvaluator

Includes:
IResource, Interfaces::AWSBedrockagentcore::IEvaluatorRef
Included in:
EvaluatorBase
Defined in:
bedrock_agent_core/i_evaluator.rb

Overview

Interface for Evaluator resources.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'bedrock_agent_core/i_evaluator.rb', line 131

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :evaluator_ref => { kind: :property, name: "evaluatorRef", 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 },
    :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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
  }
end

Instance Method Details

#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:



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

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) 


69
70
71
 
# File 'bedrock_agent_core/i_evaluator.rb', line 69

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:



27
28
29
 
# File 'bedrock_agent_core/i_evaluator.rb', line 27

def env()
  jsii_get_property("env")
end

#evaluator_arn ⇒ String

The ARN of the evaluator.

Returns:

  • (String) 


48
49
50
 
# File 'bedrock_agent_core/i_evaluator.rb', line 48

def evaluator_arn()
  jsii_get_property("evaluatorArn")
end

#evaluator_id ⇒ String

The unique identifier of the evaluator.

Returns:

  • (String) 


55
56
57
 
# File 'bedrock_agent_core/i_evaluator.rb', line 55

def evaluator_id()
  jsii_get_property("evaluatorId")
end

#evaluator_name ⇒ String

The name of the evaluator.

Returns:

  • (String) 


62
63
64
 
# File 'bedrock_agent_core/i_evaluator.rb', line 62

def evaluator_name()
  jsii_get_property("evaluatorName")
end

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

A reference to a Evaluator resource.

Returns:



41
42
43
 
# File 'bedrock_agent_core/i_evaluator.rb', line 41

def evaluator_ref()
  jsii_get_property("evaluatorRef")
end

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

Grant the given principal identity permissions to perform actions on this evaluator.

Parameters:

Returns:



123
124
125
126
127
128
129
 
# File 'bedrock_agent_core/i_evaluator.rb', line 123

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) 


12
13
14
 
# File 'bedrock_agent_core/i_evaluator.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'bedrock_agent_core/i_evaluator.rb', line 34

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

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

Returns:

  • (String, nil) 


76
77
78
 
# File 'bedrock_agent_core/i_evaluator.rb', line 76

def status()
  jsii_get_property("status")
end

#updated_at ⇒ String?

The timestamp when the evaluator was last updated.

Returns:

  • (String, nil) 


83
84
85
 
# File 'bedrock_agent_core/i_evaluator.rb', line 83

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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



94
95
96
97
98
99
 
# File 'bedrock_agent_core/i_evaluator.rb', line 94

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