Module: AWSCDK::BedrockAgentCore::IGatewayTarget

Includes:
IResource, Interfaces::AWSBedrockagentcore::IGatewayTargetRef
Included in:
GatewayTargetBase, IMcpGatewayTarget
Defined in:
bedrock_agent_core/i_gateway_target.rb

Overview

Interface for GatewayTarget resources.

Represents a target that hosts tools for the gateway. Targets can be Lambda functions, OpenAPI schemas, or Smithy models.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 187

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 },
    :gateway_target_ref => { kind: :property, name: "gatewayTargetRef", is_optional: false },
    :gateway => { kind: :property, name: "gateway", is_optional: false },
    :gateway_target_name => { kind: :property, name: "gatewayTargetName", is_optional: false },
    :target_arn => { kind: :property, name: "targetArn", is_optional: false },
    :target_id => { kind: :property, name: "targetId", is_optional: false },
    :target_protocol_type => { kind: :property, name: "targetProtocolType", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", is_optional: true },
    :credential_provider_configurations => { kind: :property, name: "credentialProviderConfigurations", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :status_reasons => { kind: :property, name: "statusReasons", 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 },
    :grant_manage => { kind: :method, name: "grantManage", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", 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:



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

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?

Timestamp when the gateway target was created.

Returns:

  • (String, nil) 


86
87
88
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 86

def created_at()
  jsii_get_property("createdAt")
end

#credential_provider_configurations ⇒ Array<AWSCDK::BedrockAgentCore::ICredentialProviderConfig>?

The credential provider configuration for the target.

Returns:



93
94
95
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 93

def credential_provider_configurations()
  jsii_get_property("credentialProviderConfigurations")
end

#description ⇒ String?

The description of the gateway target.

Returns:

  • (String, nil) 


100
101
102
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 100

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



30
31
32
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 30

def env()
  jsii_get_property("env")
end

#gateway ⇒ AWSCDK::BedrockAgentCore::IGateway

The gateway that this target belongs to.

Returns:



51
52
53
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 51

def gateway()
  jsii_get_property("gateway")
end

#gateway_target_name ⇒ String

The name of the gateway target.

Returns:

  • (String) 


58
59
60
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 58

def gateway_target_name()
  jsii_get_property("gatewayTargetName")
end

#gateway_target_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::GatewayTargetReference

A reference to a GatewayTarget resource.

Returns:



44
45
46
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 44

def gateway_target_ref()
  jsii_get_property("gatewayTargetRef")
end

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

Grants IAM actions to the IAM Principal.

Parameters:

Returns:



161
162
163
164
165
166
167
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 161

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_manage(grantee) ⇒ AWSCDK::IAM::Grant

Grants Create, Update, and Delete actions on the Gateway Target.

Parameters:

Returns:



173
174
175
176
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 173

def grant_manage(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantManage", [grantee])
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Grants Get and List actions on the Gateway Target.

Parameters:

Returns:



182
183
184
185
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 182

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


15
16
17
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 15

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



37
38
39
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 37

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The status of the gateway target.

Returns:

  • (String, nil) 


107
108
109
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 107

def status()
  jsii_get_property("status")
end

#status_reasons ⇒ Array<String>?

The status reasons for the gateway target.

Returns:

  • (Array<String>, nil) 


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

def status_reasons()
  jsii_get_property("statusReasons")
end

#target_arn ⇒ String

The ARN of the gateway target resource.

Returns:

  • (String) 


65
66
67
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 65

def target_arn()
  jsii_get_property("targetArn")
end

#target_id ⇒ String

The id of the gateway target.

Returns:

  • (String) 


72
73
74
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 72

def target_id()
  jsii_get_property("targetId")
end

#target_protocol_type ⇒ AWSCDK::BedrockAgentCore::GatewayTargetProtocolType

The target protocol.

Returns:



79
80
81
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 79

def target_protocol_type()
  jsii_get_property("targetProtocolType")
end

#updated_at ⇒ String?

Timestamp when the gateway target was last updated.

Returns:

  • (String, nil) 


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

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



132
133
134
135
136
137
 
# File 'bedrock_agent_core/i_gateway_target.rb', line 132

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