@aws-cdk/aws-bedrock-agentcore-alpha 2.225.0-alpha.0 → 2.227.0-alpha.0

package/agentcore/gateway/targets/target-base.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatewayTargetBase = exports.McpTargetType = exports.GatewayTargetProtocolType = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const iam = require("aws-cdk-lib/aws-iam");
+/******************************************************************************
+ *                                 ENUM
+ *****************************************************************************/
+/**
+ * Protocol types supported by gateway targets
+ */
+var GatewayTargetProtocolType;
+(function (GatewayTargetProtocolType) {
+    /** Model Context Protocol type */
+    GatewayTargetProtocolType["MCP"] = "MCP";
+})(GatewayTargetProtocolType || (exports.GatewayTargetProtocolType = GatewayTargetProtocolType = {}));
+/**
+ * MCP target types
+ */
+var McpTargetType;
+(function (McpTargetType) {
+    /** OpenAPI schema target type */
+    McpTargetType["OPENAPI_SCHEMA"] = "OPENAPI_SCHEMA";
+    /** Smithy model target type */
+    McpTargetType["SMITHY_MODEL"] = "SMITHY_MODEL";
+    /** Lambda function target type */
+    McpTargetType["LAMBDA"] = "LAMBDA";
+    /** MCP server target type */
+    McpTargetType["MCP_SERVER"] = "MCP_SERVER";
+})(McpTargetType || (exports.McpTargetType = McpTargetType = {}));
+/******************************************************************************
+ *                                Base Class
+ *****************************************************************************/
+/**
+ * Base class for gateway target implementations
+ *
+ * Provides common functionality for all gateway target types including
+ * permission management and property definitions.
+ */
+class GatewayTargetBase extends aws_cdk_lib_1.Resource {
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@aws-cdk/aws-bedrock-agentcore-alpha.GatewayTargetBase", version: "2.227.0-alpha.0" };
+    /**
+     * Grants IAM actions to the IAM Principal
+     *
+     * @param grantee The principal to grant permissions to
+     * @param actions The IAM actions to grant
+     */
+    grant(grantee, ...actions) {
+        return iam.Grant.addToPrincipal({
+            grantee: grantee,
+            resourceArns: [this.targetArn],
+            actions: actions,
+        });
+    }
+    /**
+     * Grants `Get` and `List` actions on the Gateway Target
+     *
+     * @param grantee The principal to grant read permissions to
+     */
+    grantRead(grantee) {
+        const resourceSpecificGrant = this.grant(grantee, 'bedrock-agentcore:GetGatewayTarget');
+        const allResourceGrant = iam.Grant.addToPrincipal({
+            grantee: grantee,
+            resourceArns: ['*'],
+            actions: ['bedrock-agentcore:ListGatewayTargets'],
+        });
+        // Return combined grant
+        return resourceSpecificGrant.combine(allResourceGrant);
+    }
+    /**
+     * Grants `Create`, `Update`, and `Delete` actions on the Gateway Target
+     *
+     * @param grantee The principal to grant manage permissions to
+     */
+    grantManage(grantee) {
+        return this.grant(grantee, 'bedrock-agentcore:CreateGatewayTarget', 'bedrock-agentcore:UpdateGatewayTarget', 'bedrock-agentcore:DeleteGatewayTarget');
+    }
+}
+exports.GatewayTargetBase = GatewayTargetBase;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"target-base.js","sourceRoot":"","sources":["target-base.ts"],"names":[],"mappings":";;;;AAAA,6CAAkD;AAClD,2CAA2C;AAI3C;;+EAE+E;AAC/E;;GAEG;AACH,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACnC,kCAAkC;IAClC,wCAAW,CAAA;AACb,CAAC,EAHW,yBAAyB,yCAAzB,yBAAyB,QAGpC;AAED;;GAEG;AACH,IAAY,aASX;AATD,WAAY,aAAa;IACvB,iCAAiC;IACjC,kDAAiC,CAAA;IACjC,+BAA+B;IAC/B,8CAA6B,CAAA;IAC7B,kCAAkC;IAClC,kCAAiB,CAAA;IACjB,6BAA6B;IAC7B,0CAAyB,CAAA;AAC3B,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;AAuGD;;+EAE+E;AAC/E;;;;;GAKG;AACH,MAAsB,iBAAkB,SAAQ,sBAAQ;;IAatD;;;;;OAKG;IACI,KAAK,CAAC,OAAuB,EAAE,GAAG,OAAiB;QACxD,OAAO,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC;YAC9B,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;YAC9B,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;KACJ;IAED;;;;OAIG;IACI,SAAS,CAAC,OAAuB;QACtC,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,oCAAoC,CAAC,CAAC;QAExF,MAAM,gBAAgB,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC;YAChD,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,CAAC,GAAG,CAAC;YACnB,OAAO,EAAE,CAAC,sCAAsC,CAAC;SAClD,CAAC,CAAC;QACH,wBAAwB;QACxB,OAAO,qBAAqB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;KACxD;IAED;;;;OAIG;IACI,WAAW,CAAC,OAAuB;QACxC,OAAO,IAAI,CAAC,KAAK,CACf,OAAO,EACP,uCAAuC,EACvC,uCAAuC,EACvC,uCAAuC,CACxC,CAAC;KACH;;AAxDH,8CAyDC","sourcesContent":["import { Resource, IResource } from 'aws-cdk-lib';\nimport * as iam from 'aws-cdk-lib/aws-iam';\nimport { IGateway } from '../gateway-base';\nimport { ICredentialProviderConfig } from '../outbound-auth/credential-provider';\n\n/******************************************************************************\n *                                 ENUM\n *****************************************************************************/\n/**\n * Protocol types supported by gateway targets\n */\nexport enum GatewayTargetProtocolType {\n  /** Model Context Protocol type */\n  MCP = 'MCP',\n}\n\n/**\n * MCP target types\n */\nexport enum McpTargetType {\n  /** OpenAPI schema target type */\n  OPENAPI_SCHEMA = 'OPENAPI_SCHEMA',\n  /** Smithy model target type */\n  SMITHY_MODEL = 'SMITHY_MODEL',\n  /** Lambda function target type */\n  LAMBDA = 'LAMBDA',\n  /** MCP server target type */\n  MCP_SERVER = 'MCP_SERVER',\n}\n\n/******************************************************************************\n *                                Interface\n *****************************************************************************/\n\n/**\n * Interface for GatewayTarget resources\n *\n * Represents a target that hosts tools for the gateway.\n * Targets can be Lambda functions, OpenAPI schemas, or Smithy models.\n */\nexport interface IGatewayTarget extends IResource {\n  /**\n   * The ARN of the gateway target resource\n   * @attribute\n   */\n  readonly targetArn: string;\n\n  /**\n   * The id of the gateway target\n   * @attribute\n   */\n  readonly targetId: string;\n\n  /**\n   * The name of the gateway target\n   */\n  readonly name: string;\n\n  /**\n   * The description of the gateway target\n   */\n  readonly description?: string;\n\n  /**\n   * The gateway that this target belongs to\n   */\n  readonly gateway: IGateway;\n\n  /**\n   * The target protocol\n   */\n  readonly targetProtocolType: GatewayTargetProtocolType;\n\n  /**\n   * The credential provider configuration for the target\n   */\n  readonly credentialProviderConfigurations: ICredentialProviderConfig[] | undefined;\n\n  /**\n   * The status of the gateway target\n   * @attribute\n   */\n  readonly status?: string;\n\n  /**\n   * The status reasons for the gateway target\n   * @attribute\n   */\n  readonly statusReasons?: string[];\n\n  /**\n   * Timestamp when the gateway target was created\n   * @attribute\n   */\n  readonly createdAt?: string;\n\n  /**\n   * Timestamp when the gateway target was last updated\n   * @attribute\n   */\n  readonly updatedAt?: string;\n\n  /**\n   * Grants IAM actions to the IAM Principal\n   */\n  grant(grantee: iam.IGrantable, ...actions: string[]): iam.Grant;\n\n  /**\n   * Grants `Get` and `List` actions on the Gateway Target\n   */\n  grantRead(grantee: iam.IGrantable): iam.Grant;\n\n  /**\n   * Grants `Create`, `Update`, and `Delete` actions on the Gateway Target\n   */\n  grantManage(grantee: iam.IGrantable): iam.Grant;\n}\n\n/**\n * Interface for MCP gateway targets\n *\n * Extends the base gateway target interface with MCP-specific properties.\n * MCP targets expose tools using the Model Context Protocol.\n */\nexport interface IMcpGatewayTarget extends IGatewayTarget {\n  /**\n   * The type of target (Lambda, OpenAPI, or Smithy)\n   */\n  readonly targetType: McpTargetType;\n}\n\n/******************************************************************************\n *                                Base Class\n *****************************************************************************/\n/**\n * Base class for gateway target implementations\n *\n * Provides common functionality for all gateway target types including\n * permission management and property definitions.\n */\nexport abstract class GatewayTargetBase extends Resource implements IGatewayTarget {\n  public abstract readonly targetArn: string;\n  public abstract readonly targetId: string;\n  public abstract readonly name: string;\n  public abstract readonly description?: string;\n  public abstract readonly gateway: IGateway;\n  public abstract readonly credentialProviderConfigurations: ICredentialProviderConfig[] | undefined;\n  public abstract readonly status?: string;\n  public abstract readonly statusReasons?: string[];\n  public abstract readonly createdAt?: string;\n  public abstract readonly updatedAt?: string;\n  public abstract readonly targetProtocolType: GatewayTargetProtocolType;\n\n  /**\n   * Grants IAM actions to the IAM Principal\n   *\n   * @param grantee The principal to grant permissions to\n   * @param actions The IAM actions to grant\n   */\n  public grant(grantee: iam.IGrantable, ...actions: string[]): iam.Grant {\n    return iam.Grant.addToPrincipal({\n      grantee: grantee,\n      resourceArns: [this.targetArn],\n      actions: actions,\n    });\n  }\n\n  /**\n   * Grants `Get` and `List` actions on the Gateway Target\n   *\n   * @param grantee The principal to grant read permissions to\n   */\n  public grantRead(grantee: iam.IGrantable): iam.Grant {\n    const resourceSpecificGrant = this.grant(grantee, 'bedrock-agentcore:GetGatewayTarget');\n\n    const allResourceGrant = iam.Grant.addToPrincipal({\n      grantee: grantee,\n      resourceArns: ['*'],\n      actions: ['bedrock-agentcore:ListGatewayTargets'],\n    });\n    // Return combined grant\n    return resourceSpecificGrant.combine(allResourceGrant);\n  }\n\n  /**\n   * Grants `Create`, `Update`, and `Delete` actions on the Gateway Target\n   *\n   * @param grantee The principal to grant manage permissions to\n   */\n  public grantManage(grantee: iam.IGrantable): iam.Grant {\n    return this.grant(\n      grantee,\n      'bedrock-agentcore:CreateGatewayTarget',\n      'bedrock-agentcore:UpdateGatewayTarget',\n      'bedrock-agentcore:DeleteGatewayTarget',\n    );\n  }\n}\n"]}

package/agentcore/gateway/targets/target-configuration.d.ts

@@ -0,0 +1,230 @@
+import { IFunction } from 'aws-cdk-lib/aws-lambda';
+import { Construct } from 'constructs';
+import { IGateway } from '../gateway-base';
+import { ApiSchema } from './schema/api-schema';
+import { ToolSchema } from './schema/tool-schema';
+import { McpTargetType } from './target-base';
+/******************************************************************************
+ *                          Interface
+ *****************************************************************************/
+/**
+ * Configuration returned by binding a target configuration
+ */
+export interface TargetConfigurationConfig {
+    /**
+     * Indicates that the configuration has been successfully bound
+     */
+    readonly bound: boolean;
+}
+/**
+ * Base interface for target configurations
+ */
+export interface ITargetConfiguration {
+    /**
+     * The target type
+     */
+    readonly targetType: McpTargetType;
+    /**
+     * Binds the configuration to a construct scope
+     * Sets up permissions and dependencies
+     */
+    bind(scope: Construct, gateway: IGateway): TargetConfigurationConfig;
+    /**
+     * Renders the configuration as CloudFormation properties
+     * @internal
+     */
+    _render(): any;
+}
+/******************************************************************************
+ *                     MCP Target Configuration Base
+ *****************************************************************************/
+/**
+ * Abstract base class for MCP target configurations
+ * Provides common functionality for all MCP target types
+ */
+export declare abstract class McpTargetConfiguration implements ITargetConfiguration {
+    /**
+     * The target type
+     */
+    abstract readonly targetType: McpTargetType;
+    /**
+     * Binds the configuration to a construct scope
+     * Sets up permissions and dependencies
+     */
+    abstract bind(scope: Construct, gateway: IGateway): TargetConfigurationConfig;
+    /**
+     * Renders the MCP-specific configuration
+     */
+    protected abstract renderMcpConfiguration(): any;
+    /**
+     * Renders the configuration as CloudFormation properties
+     * @internal
+     */
+    _render(): any;
+}
+/******************************************************************************
+ *                     Lambda Target Configuration
+ *****************************************************************************/
+/**
+ * Configuration for Lambda-based MCP targets
+ *
+ * This configuration wraps a Lambda function as MCP tools,
+ * allowing the gateway to invoke the function to provide tool capabilities.
+ */
+export declare class LambdaTargetConfiguration extends McpTargetConfiguration {
+    /**
+     * Create a Lambda target configuration
+     *
+     * @param lambdaFunction The Lambda function to invoke
+     * @param toolSchema The schema defining the tools
+     * @returns A new LambdaTargetConfiguration instance
+     */
+    static create(lambdaFunction: IFunction, toolSchema: ToolSchema): LambdaTargetConfiguration;
+    readonly targetType = McpTargetType.LAMBDA;
+    /**
+     * The Lambda function that implements the MCP server logic
+     */
+    readonly lambdaFunction: IFunction;
+    /**
+     * The tool schema that defines the available tools
+     */
+    readonly toolSchema: ToolSchema;
+    constructor(lambdaFunction: IFunction, toolSchema: ToolSchema);
+    /**
+     * Binds this configuration to a construct scope
+     * Sets up necessary permissions for the gateway to invoke the Lambda function
+     *
+     * @param scope The construct scope
+     * @param gateway The gateway that will use this target
+     */
+    bind(scope: Construct, gateway: IGateway): TargetConfigurationConfig;
+    /**
+     * Renders the MCP-specific configuration
+     */
+    protected renderMcpConfiguration(): any;
+}
+/******************************************************************************
+ *                     OpenAPI Target Configuration
+ *****************************************************************************/
+/**
+ * Configuration for OpenAPI-based MCP targets
+ *
+ * This configuration exposes an OpenAPI/REST API as MCP tools,
+ * allowing the gateway to transform API operations into tool calls.
+ */
+export declare class OpenApiTargetConfiguration extends McpTargetConfiguration {
+    /**
+     * Create an OpenAPI target configuration
+     *
+     * @param apiSchema The OpenAPI schema
+     * @param validateSchema Whether to validate the OpenAPI schema (only applies to inline schemas)
+     * @returns A new OpenApiTargetConfiguration instance
+     */
+    static create(apiSchema: ApiSchema, validateSchema?: boolean): OpenApiTargetConfiguration;
+    readonly targetType = McpTargetType.OPENAPI_SCHEMA;
+    /**
+     * The OpenAPI schema that defines the API
+     */
+    readonly apiSchema: ApiSchema;
+    /**
+     * Whether to validate the OpenAPI schema
+     */
+    private readonly shouldValidateSchema;
+    constructor(apiSchema: ApiSchema, validateSchema?: boolean);
+    /**
+     * Binds this configuration to a construct scope
+     * Sets up necessary permissions for the gateway to access the API schema
+     *
+     * @param scope The construct scope
+     * @param gateway The gateway that will use this target
+     */
+    bind(scope: Construct, gateway: IGateway): TargetConfigurationConfig;
+    /**
+     * Renders the MCP-specific configuration
+     */
+    protected renderMcpConfiguration(): any;
+}
+/******************************************************************************
+ *                     Smithy Target Configuration
+ *****************************************************************************/
+/**
+ * Configuration for Smithy-based MCP targets
+ *
+ * This configuration exposes a Smithy-modeled API as MCP tools,
+ * allowing the gateway to transform Smithy operations into tool calls.
+ */
+export declare class SmithyTargetConfiguration extends McpTargetConfiguration {
+    /**
+     * Create a Smithy target configuration
+     *
+     * @param smithyModel The Smithy model schema
+     * @returns A new SmithyTargetConfiguration instance
+     */
+    static create(smithyModel: ApiSchema): SmithyTargetConfiguration;
+    readonly targetType = McpTargetType.SMITHY_MODEL;
+    /**
+     * The Smithy model that defines the API
+     */
+    readonly smithyModel: ApiSchema;
+    constructor(smithyModel: ApiSchema);
+    /**
+     * Binds this configuration to a construct scope
+     * Sets up necessary permissions for the gateway to access the Smithy model
+     *
+     * @param scope The construct scope
+     * @param gateway The gateway that will use this target
+     */
+    bind(scope: Construct, gateway: IGateway): TargetConfigurationConfig;
+    /**
+     * Renders the MCP-specific configuration
+     */
+    protected renderMcpConfiguration(): any;
+}
+/******************************************************************************
+ *                     MCP Server Target Configuration
+ *****************************************************************************/
+/**
+ * Configuration for MCP Server-based targets
+ *
+ * MCP (Model Context Protocol) servers provide tools, data access, and custom
+ * functions for AI agents. When you configure an MCP server as a gateway target,
+ * the gateway automatically discovers and indexes available tools through
+ * synchronization.
+ */
+export declare class McpServerTargetConfiguration extends McpTargetConfiguration {
+    /**
+     * Create an MCP server target configuration
+     *
+     * @param endpoint The HTTPS endpoint URL of the MCP server
+     * @returns A new McpServerTargetConfiguration instance
+     */
+    static create(endpoint: string): McpServerTargetConfiguration;
+    readonly targetType = McpTargetType.MCP_SERVER;
+    /**
+     * The HTTPS endpoint URL of the MCP server
+     */
+    readonly endpoint: string;
+    constructor(endpoint: string);
+    /**
+     * Binds this configuration to a construct scope
+     * No additional permissions are needed for MCP server targets
+     *
+     * @param _scope The construct scope
+     * @param _gateway The gateway that will use this target
+     */
+    bind(_scope: Construct, _gateway: IGateway): TargetConfigurationConfig;
+    /**
+     * Renders the MCP-specific configuration
+     */
+    protected renderMcpConfiguration(): any;
+    /**
+     * Validates the MCP server endpoint
+     * - Must use HTTPS protocol
+     * - Should be properly URL encoded
+     *
+     * @param endpoint The endpoint URL to validate
+     * @throws ValidationError if the endpoint is invalid
+     * @internal
+     */
+    private validateEndpoint;
+}