Class: AWSCDK::BedrockAgentCore::GatewayTarget
- Inherits:
-
GatewayTargetBase
- Object
- GatewayTargetBase
- AWSCDK::BedrockAgentCore::GatewayTarget
- Includes:
- IMcpGatewayTarget
- Defined in:
- bedrock_agent_core/gateway_target.rb
Overview
Defines tools that your gateway will host.
Supports multiple target types:
- Lambda: Wraps a Lambda function as MCP tools
- OpenAPI: Exposes an OpenAPI/REST API as MCP tools
- Smithy: Exposes a Smithy-modeled API as MCP tools
Class Method Summary collapse
-
.for_api_gateway(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create an API Gateway-based target Convenience method for creating a target that connects to an API Gateway REST API.
-
.for_lambda(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create a Lambda-based MCP target Convenience method for creating a target that wraps a Lambda function.
-
.for_mcp_server(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create an MCP Server-based target Convenience method for creating a target that connects to an external MCP server.
-
.for_open_api(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create an OpenAPI-based MCP target Convenience method for creating a target that exposes an OpenAPI/REST API.
-
.for_smithy(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create a Smithy-based MCP target Convenience method for creating a target that exposes a Smithy-modeled API.
-
.from_gateway_target_attributes(scope, id, attrs) ⇒ AWSCDK::BedrockAgentCore::IGatewayTarget
Import an existing Gateway Target using its attributes This allows you to reference a Gateway Target that was created outside of CDK.
- .jsii_overridable_methods ⇒ Object
-
.PROPERTY_INJECTION_ID ⇒ String
Uniquely identifies this class.
Instance Method Summary collapse
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Override the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy) ⇒ void
Apply the given removal policy to this resource.
-
#created_at ⇒ String?
Timestamp when the gateway target was created.
-
#credential_provider_configurations ⇒ Array<AWSCDK::BedrockAgentCore::ICredentialProviderConfig>?
The credential providers for this target.
-
#description ⇒ String?
Optional description for the gateway target.
-
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
The environment this resource belongs to.
-
#gateway ⇒ AWSCDK::BedrockAgentCore::IGateway
The gateway this target belongs to.
-
#gateway_target_name ⇒ String
The name of the gateway target.
-
#gateway_target_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::GatewayTargetReference
A reference to a GatewayTarget resource.
- #generate_physical_name ⇒ String
-
#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). -
#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). -
#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant
Grants IAM actions to the IAM Principal.
-
#grant_manage(grantee) ⇒ AWSCDK::IAM::Grant
Grants
Create,Update, andDeleteactions on the Gateway Target. -
#grant_read(grantee) ⇒ AWSCDK::IAM::Grant
Grants
GetandListactions on the Gateway Target. -
#grant_sync(grantee) ⇒ AWSCDK::IAM::Grant
Grants permission to synchronize this gateway's targets.
-
#initialize(scope, id, props) ⇒ GatewayTarget
constructor
A new instance of GatewayTarget.
-
#node ⇒ Constructs::Node
The tree node.
-
#physical_name ⇒ String
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
-
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
-
#status ⇒ String?
The status of the gateway target.
-
#status_reasons ⇒ Array<String>?
The status reasons for the gateway target.
-
#target_arn ⇒ String
The ARN of the gateway target.
-
#target_id ⇒ String
The unique identifier of the gateway target.
-
#target_protocol_type ⇒ AWSCDK::BedrockAgentCore::GatewayTargetProtocolType
The protocol type (always MCP for now).
-
#target_type ⇒ AWSCDK::BedrockAgentCore::McpTargetType
The specific MCP target type (Lambda, OpenAPI, Smithy, or MCP Server).
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_at ⇒ String?
Timestamp when the gateway target was last updated.
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ GatewayTarget
Returns a new instance of GatewayTarget.
20 21 22 23 24 25 26 |
# File 'bedrock_agent_core/gateway_target.rb', line 20 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::GatewayTargetProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5HYXRld2F5VGFyZ2V0UHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.for_api_gateway(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create an API Gateway-based target Convenience method for creating a target that connects to an API Gateway REST API.
68 69 70 71 72 73 74 |
# File 'bedrock_agent_core/gateway_target.rb', line 68 def self.for_api_gateway(scope, id, 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") props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::GatewayTargetAPIGatewayProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5HYXRld2F5VGFyZ2V0QXBpR2F0ZXdheVByb3BzIn0=")), "props") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.GatewayTarget", "forApiGateway", [scope, id, props]) end |
.for_lambda(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create a Lambda-based MCP target Convenience method for creating a target that wraps a Lambda function.
82 83 84 85 86 87 88 |
# File 'bedrock_agent_core/gateway_target.rb', line 82 def self.for_lambda(scope, id, 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") props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::GatewayTargetLambdaProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5HYXRld2F5VGFyZ2V0TGFtYmRhUHJvcHMifQ==")), "props") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.GatewayTarget", "forLambda", [scope, id, props]) end |
.for_mcp_server(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create an MCP Server-based target Convenience method for creating a target that connects to an external MCP server.
97 98 99 100 101 102 103 |
# File 'bedrock_agent_core/gateway_target.rb', line 97 def self.for_mcp_server(scope, id, 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") props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::GatewayTargetMcpServerProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5HYXRld2F5VGFyZ2V0TWNwU2VydmVyUHJvcHMifQ==")), "props") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.GatewayTarget", "forMcpServer", [scope, id, props]) end |
.for_open_api(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create an OpenAPI-based MCP target Convenience method for creating a target that exposes an OpenAPI/REST API.
111 112 113 114 115 116 117 |
# File 'bedrock_agent_core/gateway_target.rb', line 111 def self.for_open_api(scope, id, 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") props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::GatewayTargetOpenAPIProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5HYXRld2F5VGFyZ2V0T3BlbkFwaVByb3BzIn0=")), "props") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.GatewayTarget", "forOpenApi", [scope, id, props]) end |
.for_smithy(scope, id, props) ⇒ AWSCDK::BedrockAgentCore::GatewayTarget
Create a Smithy-based MCP target Convenience method for creating a target that exposes a Smithy-modeled API.
125 126 127 128 129 130 131 |
# File 'bedrock_agent_core/gateway_target.rb', line 125 def self.for_smithy(scope, id, 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") props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::GatewayTargetSmithyProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5HYXRld2F5VGFyZ2V0U21pdGh5UHJvcHMifQ==")), "props") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.GatewayTarget", "forSmithy", [scope, id, props]) end |
.from_gateway_target_attributes(scope, id, attrs) ⇒ AWSCDK::BedrockAgentCore::IGatewayTarget
Import an existing Gateway Target using its attributes This allows you to reference a Gateway Target that was created outside of CDK.
139 140 141 142 143 144 145 |
# File 'bedrock_agent_core/gateway_target.rb', line 139 def self.from_gateway_target_attributes(scope, id, attrs) Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") attrs = attrs.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::GatewayTargetAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5HYXRld2F5VGFyZ2V0QXR0cmlidXRlcyJ9")), "attrs") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.GatewayTarget", "fromGatewayTargetAttributes", [scope, id, attrs]) end |
.jsii_overridable_methods ⇒ Object
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'bedrock_agent_core/gateway_target.rb', line 28 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 }, :gateway => { kind: :property, name: "gateway", is_optional: false }, :gateway_target_name => { kind: :property, name: "gatewayTargetName", is_optional: false }, :gateway_target_ref => { kind: :property, name: "gatewayTargetRef", 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 }, :target_type => { kind: :property, name: "targetType", is_optional: false }, :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 }, :grant_manage => { kind: :method, name: "grantManage", is_optional: false }, :grant_read => { kind: :method, name: "grantRead", is_optional: false }, :grant_sync => { kind: :method, name: "grantSync", is_optional: false }, } end |
.PROPERTY_INJECTION_ID ⇒ String
Uniquely identifies this class.
277 278 279 |
# File 'bedrock_agent_core/gateway_target.rb', line 277 def self.PROPERTY_INJECTION_ID() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_bedrockagentcore.GatewayTarget", "PROPERTY_INJECTION_ID") 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.
321 322 323 324 |
# File 'bedrock_agent_core/gateway_target.rb', line 321 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).
338 339 340 341 |
# File 'bedrock_agent_core/gateway_target.rb', line 338 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.
235 236 237 |
# File 'bedrock_agent_core/gateway_target.rb', line 235 def created_at() jsii_get_property("createdAt") end |
#credential_provider_configurations ⇒ Array<AWSCDK::BedrockAgentCore::ICredentialProviderConfig>?
The credential providers for this target.
242 243 244 |
# File 'bedrock_agent_core/gateway_target.rb', line 242 def credential_provider_configurations() jsii_get_property("credentialProviderConfigurations") end |
#description ⇒ String?
Optional description for the gateway target.
249 250 251 |
# File 'bedrock_agent_core/gateway_target.rb', line 249 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.
165 166 167 |
# File 'bedrock_agent_core/gateway_target.rb', line 165 def env() jsii_get_property("env") end |
#gateway ⇒ AWSCDK::BedrockAgentCore::IGateway
The gateway this target belongs to.
193 194 195 |
# File 'bedrock_agent_core/gateway_target.rb', line 193 def gateway() jsii_get_property("gateway") end |
#gateway_target_name ⇒ String
The name of the gateway target.
200 201 202 |
# File 'bedrock_agent_core/gateway_target.rb', line 200 def gateway_target_name() jsii_get_property("gatewayTargetName") end |
#gateway_target_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::GatewayTargetReference
A reference to a GatewayTarget resource.
207 208 209 |
# File 'bedrock_agent_core/gateway_target.rb', line 207 def gateway_target_ref() jsii_get_property("gatewayTargetRef") end |
#generate_physical_name ⇒ String
344 345 346 |
# File 'bedrock_agent_core/gateway_target.rb', line 344 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.
358 359 360 361 362 363 |
# File 'bedrock_agent_core/gateway_target.rb', line 358 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.
373 374 375 376 |
# File 'bedrock_agent_core/gateway_target.rb', line 373 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]
385 386 387 388 389 390 391 |
# File 'bedrock_agent_core/gateway_target.rb', line 385 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.
[disable-awslint:no-grants]
399 400 401 402 |
# File 'bedrock_agent_core/gateway_target.rb', line 399 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.
[disable-awslint:no-grants]
410 411 412 413 |
# File 'bedrock_agent_core/gateway_target.rb', line 410 def grant_read(grantee) Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee") jsii_call_method("grantRead", [grantee]) end |
#grant_sync(grantee) ⇒ AWSCDK::IAM::Grant
Grants permission to synchronize this gateway's targets.
This method grants the SynchronizeGatewayTargets permission, which is primarily
needed for MCP Server targets when you need to refresh the tool catalog after the
MCP server's tools have changed.
[disable-awslint:no-grants]
425 426 427 428 |
# File 'bedrock_agent_core/gateway_target.rb', line 425 def grant_sync(grantee) Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee") jsii_call_method("grantSync", [grantee]) end |
#node ⇒ Constructs::Node
The tree node.
150 151 152 |
# File 'bedrock_agent_core/gateway_target.rb', line 150 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.
179 180 181 |
# File 'bedrock_agent_core/gateway_target.rb', line 179 def physical_name() jsii_get_property("physicalName") end |
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
186 187 188 |
# File 'bedrock_agent_core/gateway_target.rb', line 186 def stack() jsii_get_property("stack") end |
#status ⇒ String?
The status of the gateway target.
256 257 258 |
# File 'bedrock_agent_core/gateway_target.rb', line 256 def status() jsii_get_property("status") end |
#status_reasons ⇒ Array<String>?
The status reasons for the gateway target.
263 264 265 |
# File 'bedrock_agent_core/gateway_target.rb', line 263 def status_reasons() jsii_get_property("statusReasons") end |
#target_arn ⇒ String
The ARN of the gateway target.
214 215 216 |
# File 'bedrock_agent_core/gateway_target.rb', line 214 def target_arn() jsii_get_property("targetArn") end |
#target_id ⇒ String
The unique identifier of the gateway target.
221 222 223 |
# File 'bedrock_agent_core/gateway_target.rb', line 221 def target_id() jsii_get_property("targetId") end |
#target_protocol_type ⇒ AWSCDK::BedrockAgentCore::GatewayTargetProtocolType
The protocol type (always MCP for now).
228 229 230 |
# File 'bedrock_agent_core/gateway_target.rb', line 228 def target_protocol_type() jsii_get_property("targetProtocolType") end |
#target_type ⇒ AWSCDK::BedrockAgentCore::McpTargetType
The specific MCP target type (Lambda, OpenAPI, Smithy, or MCP Server).
284 285 286 |
# File 'bedrock_agent_core/gateway_target.rb', line 284 def target_type() jsii_get_property("targetType") end |
#to_string ⇒ String
Returns a string representation of this construct.
291 292 293 |
# File 'bedrock_agent_core/gateway_target.rb', line 291 def to_string() jsii_call_method("toString", []) end |
#updated_at ⇒ String?
Timestamp when the gateway target was last updated.
270 271 272 |
# File 'bedrock_agent_core/gateway_target.rb', line 270 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.
304 305 306 307 308 309 |
# File 'bedrock_agent_core/gateway_target.rb', line 304 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 |