Class: AWSCDK::BedrockAgentCore::OnlineEvaluationBase

Inherits:
Resource
  • Object
show all
Includes:
IOnlineEvaluationConfig
Defined in:
bedrock_agent_core/online_evaluation_base.rb

Overview

Abstract base class for OnlineEvaluationConfig.

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

Direct Known Subclasses

OnlineEvaluationConfig

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OnlineEvaluationBase.

Parameters:



14
15
16
17
18
19
20
 
# File 'bedrock_agent_core/online_evaluation_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
45
46
47
 
# File 'bedrock_agent_core/online_evaluation_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 },
    :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

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:



195
196
197
198
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 195

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:



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

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) 


130
131
132
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 130

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:



67
68
69
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 67

def env()
  jsii_get_property("env")
end

#execution_role ⇒ AWSCDK::IAM::IRole?

The IAM execution role for the evaluation.

Returns:



137
138
139
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 137

def execution_role()
  jsii_get_property("executionRole")
end

#execution_status ⇒ String?

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

Returns:

  • (String, nil) 


144
145
146
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 144

def execution_status()
  jsii_get_property("executionStatus")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


218
219
220
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 218

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) 


232
233
234
235
236
237
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 232

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) 


247
248
249
250
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 247

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:



259
260
261
262
263
264
265
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 259

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:



95
96
97
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 95

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


52
53
54
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 52

def node()
  jsii_get_property("node")
end

#online_evaluation_config_arn ⇒ String

The ARN of the online evaluation configuration.

Returns:

  • (String) 


102
103
104
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 102

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) 


109
110
111
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 109

def online_evaluation_config_id()
  jsii_get_property("onlineEvaluationConfigId")
end

#online_evaluation_config_name ⇒ String

The name of the online evaluation configuration.

Returns:

  • (String) 


116
117
118
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 116

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:



123
124
125
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 123

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) 


81
82
83
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 81

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



88
89
90
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 88

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

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

Returns:

  • (String, nil) 


151
152
153
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 151

def status()
  jsii_get_property("status")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


165
166
167
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 165

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

#updated_at ⇒ String?

The timestamp when the configuration was last updated.

Returns:

  • (String, nil) 


158
159
160
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 158

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) 


178
179
180
181
182
183
 
# File 'bedrock_agent_core/online_evaluation_base.rb', line 178

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