Interface GatewayTargetMcpServerProps
- All Superinterfaces:
GatewayTargetCommonProps,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
GatewayTargetMcpServerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
date="2026-05-19T08:18:44.416Z")
@Stability(Stable)
public interface GatewayTargetMcpServerProps
extends software.amazon.jsii.JsiiSerializable, GatewayTargetCommonProps
Properties for creating an MCP Server-based Gateway Target.
Example:
Gateway gateway = Gateway.Builder.create(this, "MyGateway")
.gatewayName("my-gateway")
.build();
// OAuth2 (recommended): use OAuth2CredentialProvider + bindForGatewayOAuthTarget, or ARNs from console/API
String oauthProviderArn = "arn:aws:bedrock-agentcore:us-east-1:123456789012:token-vault/abc123/oauth2credentialprovider/my-oauth";
String oauthSecretArn = "arn:aws:secretsmanager:us-east-1:123456789012:secret:my-oauth-secret-abc123";
// Create a gateway target with MCP Server
GatewayTarget mcpTarget = GatewayTarget.forMcpServer(this, "MyMcpServer", GatewayTargetMcpServerProps.builder()
.gatewayTargetName("my-mcp-server")
.description("External MCP server integration")
.gateway(gateway)
.endpoint("https://my-mcp-server.example.com")
.credentialProviderConfigurations(List.of(GatewayCredentialProvider.fromOauthIdentityArn(OAuthConfiguration.builder()
.providerArn(oauthProviderArn)
.secretArn(oauthSecretArn)
.scopes(List.of("mcp-runtime-server/invoke"))
.build())))
.build());
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forGatewayTargetMcpServerPropsstatic final classAn implementation forGatewayTargetMcpServerProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Credential providers for authentication.The HTTPS endpoint URL of the MCP server.The gateway this target belongs to.Methods inherited from interface software.amazon.awscdk.services.bedrockagentcore.GatewayTargetCommonProps
getDescription, getGatewayTargetNameMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCredentialProviderConfigurations
Credential providers for authentication. -
getEndpoint
The HTTPS endpoint URL of the MCP server.The endpoint must:
- Use HTTPS protocol
- Be properly URL-encoded
- Point to an MCP server that implements tool capabilities
-
getGateway
The gateway this target belongs to. -
builder
-