Module: AWSCDK::BedrockAgentCore::IOnlineEvaluationConfig

Includes:
IAM::IGrantable, IResource, Interfaces::AWSBedrockagentcore::IOnlineEvaluationConfigRef
Included in:
OnlineEvaluationBase
Defined in:
bedrock_agent_core/i_online_evaluation_config.rb

Overview

Interface for OnlineEvaluationConfig resources.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 153

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 },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :online_evaluation_config_ref => { kind: :property, name: "onlineEvaluationConfigRef", 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 },
    :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 },
    :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:



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

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) 


77
78
79
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 77

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:



28
29
30
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 28

def env()
  jsii_get_property("env")
end

#execution_role ⇒ AWSCDK::IAM::IRole?

The IAM execution role for the evaluation.

Returns:



84
85
86
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 84

def execution_role()
  jsii_get_property("executionRole")
end

#execution_status ⇒ String?

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

Returns:

  • (String, nil) 


91
92
93
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 91

def execution_status()
  jsii_get_property("executionStatus")
end

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

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

Parameters:

Returns:



145
146
147
148
149
150
151
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 145

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:



42
43
44
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 42

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


13
14
15
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 13

def node()
  jsii_get_property("node")
end

#online_evaluation_config_arn ⇒ String

The ARN of the online evaluation configuration.

Returns:

  • (String) 


56
57
58
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 56

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) 


63
64
65
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 63

def online_evaluation_config_id()
  jsii_get_property("onlineEvaluationConfigId")
end

#online_evaluation_config_name ⇒ String

The name of the online evaluation configuration.

Returns:

  • (String) 


70
71
72
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 70

def online_evaluation_config_name()
  jsii_get_property("onlineEvaluationConfigName")
end

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

A reference to a OnlineEvaluationConfig resource.

Returns:



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

def online_evaluation_config_ref()
  jsii_get_property("onlineEvaluationConfigRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



35
36
37
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 35

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

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

Returns:

  • (String, nil) 


98
99
100
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 98

def status()
  jsii_get_property("status")
end

#updated_at ⇒ String?

The timestamp when the configuration was last updated.

Returns:

  • (String, nil) 


105
106
107
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 105

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



116
117
118
119
120
121
 
# File 'bedrock_agent_core/i_online_evaluation_config.rb', line 116

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