@aws-cdk/aws-bedrock-agentcore-alpha 2.226.0-alpha.0 → 2.228.0-alpha.0

package/agentcore/gateway/inbound-auth/authorizer.d.ts

@@ -0,0 +1,121 @@
+import { IUserPoolClient, IUserPool } from 'aws-cdk-lib/aws-cognito';
+/******************************************************************************
+ *                                Authorizer Configuration
+ *****************************************************************************/
+/**
+ * Gateway authorizer type
+ */
+export declare enum GatewayAuthorizerType {
+    /** Custom JWT authorizer type */
+    CUSTOM_JWT = "CUSTOM_JWT",
+    /** AWS IAM authorizer type */
+    AWS_IAM = "AWS_IAM"
+}
+/**
+ * Abstract interface for gateway authorizer configuration
+ */
+export interface IGatewayAuthorizerConfig {
+    /**
+     * The authorizer type
+     */
+    readonly authorizerType: GatewayAuthorizerType;
+    /**
+     * The authorizer configuration in CFN format
+     * @internal
+     */
+    _render(): any;
+}
+/******************************************************************************
+ *                                  Custom JWT
+ *****************************************************************************/
+/**
+ * Custom JWT authorizer configuration
+ */
+export interface CustomJwtConfiguration {
+    /**
+     * This URL is used to fetch OpenID Connect configuration or authorization server metadata
+     * for validating incoming tokens.
+     *
+     * Pattern: .+/\.well-known/openid-configuration
+     * Required: Yes
+     */
+    readonly discoveryUrl: string;
+    /**
+     * Represents individual audience values that are validated in the incoming JWT token validation process.
+     * @default - No audience validation
+     */
+    readonly allowedAudience?: string[];
+    /**
+     * Represents individual client IDs that are validated in the incoming JWT token validation process.
+     * @default - No client ID validation
+     */
+    readonly allowedClients?: string[];
+}
+/**
+ * Custom JWT authorizer configuration implementation
+ */
+export declare class CustomJwtAuthorizer implements IGatewayAuthorizerConfig {
+    readonly authorizerType = GatewayAuthorizerType.CUSTOM_JWT;
+    private readonly discoveryUrl;
+    private readonly allowedAudience?;
+    private readonly allowedClients?;
+    constructor(config: CustomJwtConfiguration);
+    /**
+     * @internal
+     */
+    _render(): any;
+}
+/******************************************************************************
+ *                               AWS IAM
+ *****************************************************************************/
+/**
+ * AWS IAM authorizer configuration implementation
+ *
+ */
+export declare class IamAuthorizer implements IGatewayAuthorizerConfig {
+    readonly authorizerType = GatewayAuthorizerType.AWS_IAM;
+    /**
+     * @internal
+     */
+    _render(): any;
+}
+/******************************************************************************
+ *                               Factory
+ *****************************************************************************/
+export interface CognitoAuthorizerProps {
+    /**
+     * The Cognito User Pool to use for authentication
+     */
+    readonly userPool: IUserPool;
+    /**
+     * The allowed User Pool clients
+     * @default - All clients are allowed
+     */
+    readonly allowedClients?: IUserPoolClient[];
+    /**
+     * The allowed audiences for JWT validation
+     * @default - No audience validation
+     */
+    readonly allowedAudiences?: string[];
+}
+/**
+ * Factory class for creating Gateway Authorizers
+ */
+export declare abstract class GatewayAuthorizer {
+    /**
+     * AWS IAM authorizer instance
+     */
+    static usingAwsIam(): IGatewayAuthorizerConfig;
+    /**
+     * Create a custom JWT authorizer
+     * @param configuration - The JWT configuration
+     * @returns IGatewayAuthorizerConfig configured for custom JWT
+     */
+    static usingCustomJwt(configuration: CustomJwtConfiguration): IGatewayAuthorizerConfig;
+    /**
+     * Create a JWT authorizer from Cognito User Pool
+     * @param props - The Cognito configuration
+     * @returns CustomJwtAuthorizer configured for Cognito
+     */
+    static usingCognito(props: CognitoAuthorizerProps): IGatewayAuthorizerConfig;
+}

package/agentcore/gateway/inbound-auth/authorizer.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatewayAuthorizer = exports.IamAuthorizer = exports.CustomJwtAuthorizer = exports.GatewayAuthorizerType = void 0;
+const jsiiDeprecationWarnings = require("../../../.warnings.jsii.js");
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const validation_helpers_1 = require("../validation-helpers");
+/******************************************************************************
+ *                                Authorizer Configuration
+ *****************************************************************************/
+/**
+ * Gateway authorizer type
+ */
+var GatewayAuthorizerType;
+(function (GatewayAuthorizerType) {
+    /** Custom JWT authorizer type */
+    GatewayAuthorizerType["CUSTOM_JWT"] = "CUSTOM_JWT";
+    /** AWS IAM authorizer type */
+    GatewayAuthorizerType["AWS_IAM"] = "AWS_IAM";
+})(GatewayAuthorizerType || (exports.GatewayAuthorizerType = GatewayAuthorizerType = {}));
+/**
+ * Custom JWT authorizer configuration implementation
+ */
+class CustomJwtAuthorizer {
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@aws-cdk/aws-bedrock-agentcore-alpha.CustomJwtAuthorizer", version: "2.228.0-alpha.0" };
+    authorizerType = GatewayAuthorizerType.CUSTOM_JWT;
+    discoveryUrl;
+    allowedAudience;
+    allowedClients;
+    constructor(config) {
+        try {
+            jsiiDeprecationWarnings._aws_cdk_aws_bedrock_agentcore_alpha_CustomJwtConfiguration(config);
+        }
+        catch (error) {
+            if (process.env.JSII_DEBUG !== "1" && error.name === "DeprecationError") {
+                Error.captureStackTrace(error, CustomJwtAuthorizer);
+            }
+            throw error;
+        }
+        this.discoveryUrl = config.discoveryUrl;
+        this.allowedAudience = config.allowedAudience;
+        this.allowedClients = config.allowedClients;
+    }
+    /**
+     * @internal
+     */
+    _render() {
+        return {
+            customJwtAuthorizer: {
+                discoveryUrl: this.discoveryUrl,
+                ...(this.allowedAudience && { allowedAudience: this.allowedAudience }),
+                ...(this.allowedClients && { allowedClients: this.allowedClients }),
+            },
+        };
+    }
+}
+exports.CustomJwtAuthorizer = CustomJwtAuthorizer;
+/******************************************************************************
+ *                               AWS IAM
+ *****************************************************************************/
+/**
+ * AWS IAM authorizer configuration implementation
+ *
+ */
+class IamAuthorizer {
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@aws-cdk/aws-bedrock-agentcore-alpha.IamAuthorizer", version: "2.228.0-alpha.0" };
+    authorizerType = GatewayAuthorizerType.AWS_IAM;
+    /**
+     * @internal
+     */
+    _render() {
+        // AWS IAM authorizer doesn't need additional configuration
+        // Return null or undefined to indicate no configuration needed
+        return undefined;
+    }
+}
+exports.IamAuthorizer = IamAuthorizer;
+/**
+ * Factory class for creating Gateway Authorizers
+ */
+class GatewayAuthorizer {
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@aws-cdk/aws-bedrock-agentcore-alpha.GatewayAuthorizer", version: "2.228.0-alpha.0" };
+    /**
+     * AWS IAM authorizer instance
+     */
+    static usingAwsIam() {
+        return new IamAuthorizer();
+    }
+    /**
+     * Create a custom JWT authorizer
+     * @param configuration - The JWT configuration
+     * @returns IGatewayAuthorizerConfig configured for custom JWT
+     */
+    static usingCustomJwt(configuration) {
+        try {
+            jsiiDeprecationWarnings._aws_cdk_aws_bedrock_agentcore_alpha_CustomJwtConfiguration(configuration);
+        }
+        catch (error) {
+            if (process.env.JSII_DEBUG !== "1" && error.name === "DeprecationError") {
+                Error.captureStackTrace(error, this.usingCustomJwt);
+            }
+            throw error;
+        }
+        // At least one of allowedAudience or allowedClients must be defined for CUSTOM_JWT authorizer
+        if (!configuration.allowedAudience && !configuration.allowedClients) {
+            throw new validation_helpers_1.ValidationError('At least one of allowedAudience or allowedClients must be defined for CUSTOM_JWT authorizer');
+        }
+        return new CustomJwtAuthorizer(configuration);
+    }
+    /**
+     * Create a JWT authorizer from Cognito User Pool
+     * @param props - The Cognito configuration
+     * @returns CustomJwtAuthorizer configured for Cognito
+     */
+    static usingCognito(props) {
+        try {
+            jsiiDeprecationWarnings._aws_cdk_aws_bedrock_agentcore_alpha_CognitoAuthorizerProps(props);
+        }
+        catch (error) {
+            if (process.env.JSII_DEBUG !== "1" && error.name === "DeprecationError") {
+                Error.captureStackTrace(error, this.usingCognito);
+            }
+            throw error;
+        }
+        const discoveryUrl = `https://cognito-idp.${props.userPool.env.region}.amazonaws.com/${props.userPool.userPoolId}/.well-known/openid-configuration`;
+        return new CustomJwtAuthorizer({
+            discoveryUrl: discoveryUrl,
+            allowedClients: props.allowedClients?.flatMap((client) => client.userPoolClientId),
+            allowedAudience: props.allowedAudiences,
+        });
+    }
+}
+exports.GatewayAuthorizer = GatewayAuthorizer;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"authorizer.js","sourceRoot":"","sources":["authorizer.ts"],"names":[],"mappings":";;;;;AACA,8DAAwD;AAExD;;+EAE+E;AAE/E;;GAEG;AACH,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,iCAAiC;IACjC,kDAAyB,CAAA;IACzB,8BAA8B;IAC9B,4CAAmB,CAAA;AACrB,CAAC,EALW,qBAAqB,qCAArB,qBAAqB,QAKhC;AA+CD;;GAEG;AACH,MAAa,mBAAmB;;IACd,cAAc,GAAG,qBAAqB,CAAC,UAAU,CAAC;IACjD,YAAY,CAAS;IACrB,eAAe,CAAY;IAC3B,cAAc,CAAY;IAE3C,YAAY,MAA8B;;;;;;+CAN/B,mBAAmB;;;;QAO5B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;KAC7C;IAED;;OAEG;IACI,OAAO;QACZ,OAAO;YACL,mBAAmB,EAAE;gBACnB,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,EAAE,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;gBACtE,GAAG,CAAC,IAAI,CAAC,cAAc,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC;aACpE;SACF,CAAC;KACH;;AAvBH,kDAwBC;AAED;;+EAE+E;AAE/E;;;GAGG;AACH,MAAa,aAAa;;IACR,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC;IAE/D;;OAEG;IACH,OAAO;QACL,2DAA2D;QAC3D,+DAA+D;QAC/D,OAAO,SAAS,CAAC;KAClB;;AAVH,sCAWC;AAsBD;;GAEG;AACH,MAAsB,iBAAiB;;IACrC;;OAEG;IACI,MAAM,CAAC,WAAW;QACvB,OAAO,IAAI,aAAa,EAAE,CAAC;KAC5B;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,aAAqC;;;;;;;;;;QAChE,8FAA8F;QAC9F,IAAI,CAAC,aAAa,CAAC,eAAe,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;YACpE,MAAM,IAAI,oCAAe,CAAC,6FAA6F,CAAC,CAAC;QAC3H,CAAC;QACD,OAAO,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAAC;KAC/C;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,KAA6B;;;;;;;;;;QACtD,MAAM,YAAY,GAAG,uBAAuB,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,kBAAkB,KAAK,CAAC,QAAQ,CAAC,UAAU,mCAAmC,CAAC;QAEpJ,OAAO,IAAI,mBAAmB,CAAC;YAC7B,YAAY,EAAE,YAAY;YAC1B,cAAc,EAAE,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAClF,eAAe,EAAE,KAAK,CAAC,gBAAgB;SACxC,CAAC,CAAC;KACJ;;AAlCH,8CAmCC","sourcesContent":["import { IUserPoolClient, IUserPool } from 'aws-cdk-lib/aws-cognito';\nimport { ValidationError } from '../validation-helpers';\n\n/******************************************************************************\n *                                Authorizer Configuration\n *****************************************************************************/\n\n/**\n * Gateway authorizer type\n */\nexport enum GatewayAuthorizerType {\n  /** Custom JWT authorizer type */\n  CUSTOM_JWT = 'CUSTOM_JWT',\n  /** AWS IAM authorizer type */\n  AWS_IAM = 'AWS_IAM',\n}\n\n/**\n * Abstract interface for gateway authorizer configuration\n */\nexport interface IGatewayAuthorizerConfig {\n  /**\n   * The authorizer type\n   */\n  readonly authorizerType: GatewayAuthorizerType;\n\n  /**\n   * The authorizer configuration in CFN format\n   * @internal\n   */\n  _render(): any;\n}\n\n/******************************************************************************\n *                                  Custom JWT\n *****************************************************************************/\n/**\n * Custom JWT authorizer configuration\n */\nexport interface CustomJwtConfiguration {\n  /**\n   * This URL is used to fetch OpenID Connect configuration or authorization server metadata\n   * for validating incoming tokens.\n   *\n   * Pattern: .+/\\.well-known/openid-configuration\n   * Required: Yes\n   */\n  readonly discoveryUrl: string;\n\n  /**\n   * Represents individual audience values that are validated in the incoming JWT token validation process.\n   * @default - No audience validation\n   */\n  readonly allowedAudience?: string[];\n\n  /**\n   * Represents individual client IDs that are validated in the incoming JWT token validation process.\n   * @default - No client ID validation\n   */\n  readonly allowedClients?: string[];\n}\n\n/**\n * Custom JWT authorizer configuration implementation\n */\nexport class CustomJwtAuthorizer implements IGatewayAuthorizerConfig {\n  public readonly authorizerType = GatewayAuthorizerType.CUSTOM_JWT;\n  private readonly discoveryUrl: string;\n  private readonly allowedAudience?: string[];\n  private readonly allowedClients?: string[];\n\n  constructor(config: CustomJwtConfiguration) {\n    this.discoveryUrl = config.discoveryUrl;\n    this.allowedAudience = config.allowedAudience;\n    this.allowedClients = config.allowedClients;\n  }\n\n  /**\n   * @internal\n   */\n  public _render(): any {\n    return {\n      customJwtAuthorizer: {\n        discoveryUrl: this.discoveryUrl,\n        ...(this.allowedAudience && { allowedAudience: this.allowedAudience }),\n        ...(this.allowedClients && { allowedClients: this.allowedClients }),\n      },\n    };\n  }\n}\n\n/******************************************************************************\n *                               AWS IAM\n *****************************************************************************/\n\n/**\n * AWS IAM authorizer configuration implementation\n *\n */\nexport class IamAuthorizer implements IGatewayAuthorizerConfig {\n  public readonly authorizerType = GatewayAuthorizerType.AWS_IAM;\n\n  /**\n   * @internal\n   */\n  _render(): any {\n    // AWS IAM authorizer doesn't need additional configuration\n    // Return null or undefined to indicate no configuration needed\n    return undefined;\n  }\n}\n\n/******************************************************************************\n *                               Factory\n *****************************************************************************/\n\nexport interface CognitoAuthorizerProps {\n  /**\n   * The Cognito User Pool to use for authentication\n   */\n  readonly userPool: IUserPool;\n  /**\n   * The allowed User Pool clients\n   * @default - All clients are allowed\n   */\n  readonly allowedClients?: IUserPoolClient[];\n  /**\n   * The allowed audiences for JWT validation\n   * @default - No audience validation\n   */\n  readonly allowedAudiences?: string[];\n}\n/**\n * Factory class for creating Gateway Authorizers\n */\nexport abstract class GatewayAuthorizer {\n  /**\n   * AWS IAM authorizer instance\n   */\n  public static usingAwsIam(): IGatewayAuthorizerConfig {\n    return new IamAuthorizer();\n  }\n\n  /**\n   * Create a custom JWT authorizer\n   * @param configuration - The JWT configuration\n   * @returns IGatewayAuthorizerConfig configured for custom JWT\n   */\n  public static usingCustomJwt(configuration: CustomJwtConfiguration): IGatewayAuthorizerConfig {\n    // At least one of allowedAudience or allowedClients must be defined for CUSTOM_JWT authorizer\n    if (!configuration.allowedAudience && !configuration.allowedClients) {\n      throw new ValidationError('At least one of allowedAudience or allowedClients must be defined for CUSTOM_JWT authorizer');\n    }\n    return new CustomJwtAuthorizer(configuration);\n  }\n\n  /**\n   * Create a JWT authorizer from Cognito User Pool\n   * @param props - The Cognito configuration\n   * @returns CustomJwtAuthorizer configured for Cognito\n   */\n  public static usingCognito(props: CognitoAuthorizerProps): IGatewayAuthorizerConfig {\n    const discoveryUrl = `https://cognito-idp.${props.userPool.env.region}.amazonaws.com/${props.userPool.userPoolId}/.well-known/openid-configuration`;\n\n    return new CustomJwtAuthorizer({\n      discoveryUrl: discoveryUrl,\n      allowedClients: props.allowedClients?.flatMap((client) => client.userPoolClientId),\n      allowedAudience: props.allowedAudiences,\n    });\n  }\n}\n"]}

package/agentcore/gateway/outbound-auth/api-key.d.ts

@@ -0,0 +1,117 @@
+import { Grant, IRole } from 'aws-cdk-lib/aws-iam';
+import { CredentialProviderType, ICredentialProviderConfig } from './credential-provider';
+/******************************************************************************
+ *                                 API KEY
+ *****************************************************************************/
+/**
+ * API Key additional configuration
+ */
+export interface ApiKeyAdditionalConfiguration {
+    /**
+     * The name of the credential parameter for the API key.
+     * This parameter name is used when sending the API key to the target endpoint.
+     *
+     * Length Constraints: Minimum length of 1. Maximum length of 64.
+     * @default - 'Authorization' for HEADER, 'api_key' for QUERY_PARAMETER
+     */
+    readonly credentialParameterName?: string;
+    /**
+     * The prefix for the API key credential.
+     * This prefix is added to the API key when sending it to the target endpoint.
+     *
+     * Length Constraints: Minimum length of 1. Maximum length of 64.
+     * @default - 'Bearer ' for HEADER, no prefix for QUERY_PARAMETER
+     */
+    readonly credentialPrefix?: string;
+}
+/**
+ * API Key credential location type
+ * @internal
+ */
+export declare enum ApiKeyCredentialLocationType {
+    HEADER = "HEADER",
+    QUERY_PARAMETER = "QUERY_PARAMETER"
+}
+/**
+ * API Key location within the request
+ */
+export declare class ApiKeyCredentialLocation {
+    /**
+     * Create a header-based API key credential location
+     * @param config - Optional configuration for the credential location
+     * @returns ApiKeyCredentialLocation configured for header placement
+     */
+    static header(config?: ApiKeyAdditionalConfiguration): ApiKeyCredentialLocation;
+    /**
+     * Create a query parameter-based API key credential location
+     * @param config - Optional configuration for the credential location
+     * @returns ApiKeyCredentialLocation configured for query parameter placement
+     */
+    static queryParameter(config?: ApiKeyAdditionalConfiguration): ApiKeyCredentialLocation;
+    /**
+     * The name of the credential parameter
+     */
+    readonly credentialParameterName: string;
+    /**
+     * The prefix for the credential value
+     */
+    readonly credentialPrefix?: string;
+    /**
+     * The type of credential location (HEADER or QUERY_PARAMETER)
+     */
+    readonly credentialLocationType: string;
+    private constructor();
+}
+/**
+ * API Key configuration
+ */
+export interface ApiKeyCredentialProviderProps {
+    /**
+     * The API key credential provider ARN.
+     * This is returned when creating the API key credential provider via Console or API.
+     * Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/apikeycredentialprovider/name
+     */
+    readonly providerArn: string;
+    /**
+     * The ARN of the Secrets Manager secret containing the API key.
+     * This is returned when creating the API key credential provider via Console or API.
+     * Format: arn:aws:secretsmanager:region:account:secret:name
+     */
+    readonly secretArn: string;
+    /**
+     * The location of the API key credential.
+     * This field specifies where in the request the API key should be placed.
+     *
+     * @default - HEADER
+     */
+    readonly credentialLocation?: ApiKeyCredentialLocation;
+}
+/**
+ * API Key credential provider configuration implementation
+ * Can be used with OpenAPI targets
+ * @internal
+ */
+export declare class ApiKeyCredentialProviderConfiguration implements ICredentialProviderConfig {
+    readonly credentialProviderType = CredentialProviderType.API_KEY;
+    /**
+     * The ARN of the API key provider
+     */
+    readonly providerArn: string;
+    /**
+     * The ARN of the Secrets Manager secret
+     */
+    readonly secretArn: string;
+    /**
+     * The location configuration for the API key credential
+     */
+    readonly credentialLocation: ApiKeyCredentialLocation;
+    constructor(configuration: ApiKeyCredentialProviderProps);
+    /**
+     * Grant the needed permissions to the role for API key authentication
+     */
+    grantNeededPermissionsToRole(role: IRole): Grant | undefined;
+    /**
+     * @internal
+     */
+    _render(): any;
+}

package/agentcore/gateway/outbound-auth/api-key.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyCredentialProviderConfiguration = exports.ApiKeyCredentialLocation = exports.ApiKeyCredentialLocationType = void 0;
+const jsiiDeprecationWarnings = require("../../../.warnings.jsii.js");
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const aws_iam_1 = require("aws-cdk-lib/aws-iam");
+const credential_provider_1 = require("./credential-provider");
+const perms_1 = require("../perms");
+/**
+ * API Key credential location type
+ * @internal
+ */
+var ApiKeyCredentialLocationType;
+(function (ApiKeyCredentialLocationType) {
+    ApiKeyCredentialLocationType["HEADER"] = "HEADER";
+    ApiKeyCredentialLocationType["QUERY_PARAMETER"] = "QUERY_PARAMETER";
+})(ApiKeyCredentialLocationType || (exports.ApiKeyCredentialLocationType = ApiKeyCredentialLocationType = {}));
+/**
+ * API Key location within the request
+ */
+class ApiKeyCredentialLocation {
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@aws-cdk/aws-bedrock-agentcore-alpha.ApiKeyCredentialLocation", version: "2.228.0-alpha.0" };
+    /**
+     * Create a header-based API key credential location
+     * @param config - Optional configuration for the credential location
+     * @returns ApiKeyCredentialLocation configured for header placement
+     */
+    static header(config) {
+        try {
+            jsiiDeprecationWarnings._aws_cdk_aws_bedrock_agentcore_alpha_ApiKeyAdditionalConfiguration(config);
+        }
+        catch (error) {
+            if (process.env.JSII_DEBUG !== "1" && error.name === "DeprecationError") {
+                Error.captureStackTrace(error, this.header);
+            }
+            throw error;
+        }
+        return new ApiKeyCredentialLocation(ApiKeyCredentialLocationType.HEADER, config?.credentialParameterName ?? 'Authorization', config?.credentialPrefix ?? 'Bearer ');
+    }
+    /**
+     * Create a query parameter-based API key credential location
+     * @param config - Optional configuration for the credential location
+     * @returns ApiKeyCredentialLocation configured for query parameter placement
+     */
+    static queryParameter(config) {
+        try {
+            jsiiDeprecationWarnings._aws_cdk_aws_bedrock_agentcore_alpha_ApiKeyAdditionalConfiguration(config);
+        }
+        catch (error) {
+            if (process.env.JSII_DEBUG !== "1" && error.name === "DeprecationError") {
+                Error.captureStackTrace(error, this.queryParameter);
+            }
+            throw error;
+        }
+        return new ApiKeyCredentialLocation(ApiKeyCredentialLocationType.QUERY_PARAMETER, config?.credentialParameterName ?? 'api_key', config?.credentialPrefix);
+    }
+    /**
+     * The name of the credential parameter
+     */
+    credentialParameterName;
+    /**
+     * The prefix for the credential value
+     */
+    credentialPrefix;
+    /**
+     * The type of credential location (HEADER or QUERY_PARAMETER)
+     */
+    credentialLocationType;
+    constructor(credentialLocationType, credentialParameterName, credentialPrefix) {
+        this.credentialLocationType = credentialLocationType;
+        this.credentialParameterName = credentialParameterName;
+        this.credentialPrefix = credentialPrefix;
+    }
+}
+exports.ApiKeyCredentialLocation = ApiKeyCredentialLocation;
+/**
+ * API Key credential provider configuration implementation
+ * Can be used with OpenAPI targets
+ * @internal
+ */
+class ApiKeyCredentialProviderConfiguration {
+    credentialProviderType = credential_provider_1.CredentialProviderType.API_KEY;
+    /**
+     * The ARN of the API key provider
+     */
+    providerArn;
+    /**
+     * The ARN of the Secrets Manager secret
+     */
+    secretArn;
+    /**
+     * The location configuration for the API key credential
+     */
+    credentialLocation;
+    constructor(configuration) {
+        this.providerArn = configuration.providerArn;
+        this.secretArn = configuration.secretArn;
+        this.credentialLocation = configuration.credentialLocation ?? ApiKeyCredentialLocation.header();
+    }
+    /**
+     * Grant the needed permissions to the role for API key authentication
+     */
+    grantNeededPermissionsToRole(role) {
+        const statements = [
+            new aws_iam_1.PolicyStatement({
+                actions: [
+                    ...perms_1.GatewayPerms.GATEWAY_API_KEY_PERMS,
+                    ...perms_1.GatewayPerms.GATEWAY_WORKLOAD_IDENTITY_PERMS,
+                ],
+                resources: [this.providerArn],
+            }),
+            new aws_iam_1.PolicyStatement({
+                actions: perms_1.GatewayPerms.SECRETS_PERMS,
+                resources: [this.secretArn],
+            }),
+        ];
+        return aws_iam_1.Grant.addToPrincipal({
+            grantee: role,
+            actions: statements.flatMap(s => s.actions),
+            resourceArns: statements.flatMap(s => s.resources),
+        });
+    }
+    /**
+     * @internal
+     */
+    _render() {
+        return {
+            credentialProviderType: this.credentialProviderType,
+            credentialProvider: {
+                apiKeyCredentialProvider: {
+                    providerArn: this.providerArn,
+                    credentialLocation: this.credentialLocation.credentialLocationType,
+                    credentialParameterName: this.credentialLocation.credentialParameterName,
+                    credentialPrefix: this.credentialLocation.credentialPrefix,
+                },
+            },
+        };
+    }
+}
+exports.ApiKeyCredentialProviderConfiguration = ApiKeyCredentialProviderConfiguration;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"api-key.js","sourceRoot":"","sources":["api-key.ts"],"names":[],"mappings":";;;;;AAAA,iDAAoE;AACpE,+DAA0F;AAC1F,oCAAwC;AA6BxC;;;GAGG;AACH,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACtC,iDAAiB,CAAA;IACjB,mEAAmC,CAAA;AACrC,CAAC,EAHW,4BAA4B,4CAA5B,4BAA4B,QAGvC;AAED;;GAEG;AACH,MAAa,wBAAwB;;IACnC;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,MAAsC;;;;;;;;;;QACzD,OAAO,IAAI,wBAAwB,CACjC,4BAA4B,CAAC,MAAM,EACnC,MAAM,EAAE,uBAAuB,IAAI,eAAe,EAClD,MAAM,EAAE,gBAAgB,IAAI,SAAS,CACtC,CAAC;KACH;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,MAAsC;;;;;;;;;;QACjE,OAAO,IAAI,wBAAwB,CACjC,4BAA4B,CAAC,eAAe,EAC5C,MAAM,EAAE,uBAAuB,IAAI,SAAS,EAC5C,MAAM,EAAE,gBAAgB,CACzB,CAAC;KACH;IAED;;OAEG;IACa,uBAAuB,CAAS;IAChD;;OAEG;IACa,gBAAgB,CAAU;IAC1C;;OAEG;IACa,sBAAsB,CAAS;IAE/C,YACE,sBAA8B,EAC9B,uBAA+B,EAC/B,gBAAyB;QAEzB,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;QACrD,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;KAC1C;;AAhDH,4DAiDC;AA6BD;;;;GAIG;AACH,MAAa,qCAAqC;IAChC,sBAAsB,GAAG,4CAAsB,CAAC,OAAO,CAAC;IACxE;;OAEG;IACa,WAAW,CAAS;IACpC;;OAEG;IACa,SAAS,CAAS;IAClC;;OAEG;IACa,kBAAkB,CAA2B;IAE7D,YAAY,aAA4C;QACtD,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAC,kBAAkB,IAAI,wBAAwB,CAAC,MAAM,EAAE,CAAC;KACjG;IAED;;OAEG;IACH,4BAA4B,CAAC,IAAW;QACtC,MAAM,UAAU,GAAG;YACjB,IAAI,yBAAe,CAAC;gBAClB,OAAO,EAAE;oBACP,GAAG,oBAAY,CAAC,qBAAqB;oBACrC,GAAG,oBAAY,CAAC,+BAA+B;iBAChD;gBACD,SAAS,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;aAC9B,CAAC;YACF,IAAI,yBAAe,CAAC;gBAClB,OAAO,EAAE,oBAAY,CAAC,aAAa;gBACnC,SAAS,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;aAC5B,CAAC;SACH,CAAC;QAEF,OAAO,eAAK,CAAC,cAAc,CAAC;YAC1B,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YAC3C,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SACnD,CAAC,CAAC;KACJ;IAED;;OAEG;IACH,OAAO;QACL,OAAO;YACL,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,kBAAkB,EAAE;gBAClB,wBAAwB,EAAE;oBACxB,WAAW,EAAE,IAAI,CAAC,WAAW;oBAC7B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,sBAAsB;oBAClE,uBAAuB,EAAE,IAAI,CAAC,kBAAkB,CAAC,uBAAuB;oBACxE,gBAAgB,EAAE,IAAI,CAAC,kBAAkB,CAAC,gBAAgB;iBAC3D;aACF;SACF,CAAC;KACH;CACF;AA9DD,sFA8DC","sourcesContent":["import { Grant, IRole, PolicyStatement } from 'aws-cdk-lib/aws-iam';\nimport { CredentialProviderType, ICredentialProviderConfig } from './credential-provider';\nimport { GatewayPerms } from '../perms';\n\n/******************************************************************************\n *                                 API KEY\n *****************************************************************************/\n/**\n * API Key additional configuration\n */\nexport interface ApiKeyAdditionalConfiguration {\n\n  /**\n   * The name of the credential parameter for the API key.\n   * This parameter name is used when sending the API key to the target endpoint.\n   *\n   * Length Constraints: Minimum length of 1. Maximum length of 64.\n   * @default - 'Authorization' for HEADER, 'api_key' for QUERY_PARAMETER\n   */\n  readonly credentialParameterName?: string;\n\n  /**\n   * The prefix for the API key credential.\n   * This prefix is added to the API key when sending it to the target endpoint.\n   *\n   * Length Constraints: Minimum length of 1. Maximum length of 64.\n   * @default - 'Bearer ' for HEADER, no prefix for QUERY_PARAMETER\n   */\n  readonly credentialPrefix?: string;\n}\n\n/**\n * API Key credential location type\n * @internal\n */\nexport enum ApiKeyCredentialLocationType {\n  HEADER = 'HEADER',\n  QUERY_PARAMETER = 'QUERY_PARAMETER',\n}\n\n/**\n * API Key location within the request\n */\nexport class ApiKeyCredentialLocation {\n  /**\n   * Create a header-based API key credential location\n   * @param config - Optional configuration for the credential location\n   * @returns ApiKeyCredentialLocation configured for header placement\n   */\n  public static header(config?: ApiKeyAdditionalConfiguration) {\n    return new ApiKeyCredentialLocation(\n      ApiKeyCredentialLocationType.HEADER,\n      config?.credentialParameterName ?? 'Authorization',\n      config?.credentialPrefix ?? 'Bearer ',\n    );\n  }\n\n  /**\n   * Create a query parameter-based API key credential location\n   * @param config - Optional configuration for the credential location\n   * @returns ApiKeyCredentialLocation configured for query parameter placement\n   */\n  public static queryParameter(config?: ApiKeyAdditionalConfiguration) {\n    return new ApiKeyCredentialLocation(\n      ApiKeyCredentialLocationType.QUERY_PARAMETER,\n      config?.credentialParameterName ?? 'api_key',\n      config?.credentialPrefix,\n    );\n  }\n\n  /**\n   * The name of the credential parameter\n   */\n  public readonly credentialParameterName: string;\n  /**\n   * The prefix for the credential value\n   */\n  public readonly credentialPrefix?: string;\n  /**\n   * The type of credential location (HEADER or QUERY_PARAMETER)\n   */\n  public readonly credentialLocationType: string;\n\n  private constructor(\n    credentialLocationType: string,\n    credentialParameterName: string,\n    credentialPrefix?: string,\n  ) {\n    this.credentialLocationType = credentialLocationType;\n    this.credentialParameterName = credentialParameterName;\n    this.credentialPrefix = credentialPrefix;\n  }\n}\n\n/**\n * API Key configuration\n */\nexport interface ApiKeyCredentialProviderProps {\n  /**\n   * The API key credential provider ARN.\n   * This is returned when creating the API key credential provider via Console or API.\n   * Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/apikeycredentialprovider/name\n   */\n  readonly providerArn: string;\n\n  /**\n   * The ARN of the Secrets Manager secret containing the API key.\n   * This is returned when creating the API key credential provider via Console or API.\n   * Format: arn:aws:secretsmanager:region:account:secret:name\n   */\n  readonly secretArn: string;\n\n  /**\n   * The location of the API key credential.\n   * This field specifies where in the request the API key should be placed.\n   *\n   * @default - HEADER\n   */\n  readonly credentialLocation?: ApiKeyCredentialLocation;\n}\n\n/**\n * API Key credential provider configuration implementation\n * Can be used with OpenAPI targets\n * @internal\n */\nexport class ApiKeyCredentialProviderConfiguration implements ICredentialProviderConfig {\n  public readonly credentialProviderType = CredentialProviderType.API_KEY;\n  /**\n   * The ARN of the API key provider\n   */\n  public readonly providerArn: string;\n  /**\n   * The ARN of the Secrets Manager secret\n   */\n  public readonly secretArn: string;\n  /**\n   * The location configuration for the API key credential\n   */\n  public readonly credentialLocation: ApiKeyCredentialLocation;\n\n  constructor(configuration: ApiKeyCredentialProviderProps) {\n    this.providerArn = configuration.providerArn;\n    this.secretArn = configuration.secretArn;\n    this.credentialLocation = configuration.credentialLocation ?? ApiKeyCredentialLocation.header();\n  }\n\n  /**\n   * Grant the needed permissions to the role for API key authentication\n   */\n  grantNeededPermissionsToRole(role: IRole): Grant | undefined {\n    const statements = [\n      new PolicyStatement({\n        actions: [\n          ...GatewayPerms.GATEWAY_API_KEY_PERMS,\n          ...GatewayPerms.GATEWAY_WORKLOAD_IDENTITY_PERMS,\n        ],\n        resources: [this.providerArn],\n      }),\n      new PolicyStatement({\n        actions: GatewayPerms.SECRETS_PERMS,\n        resources: [this.secretArn],\n      }),\n    ];\n\n    return Grant.addToPrincipal({\n      grantee: role,\n      actions: statements.flatMap(s => s.actions),\n      resourceArns: statements.flatMap(s => s.resources),\n    });\n  }\n\n  /**\n   * @internal\n   */\n  _render(): any {\n    return {\n      credentialProviderType: this.credentialProviderType,\n      credentialProvider: {\n        apiKeyCredentialProvider: {\n          providerArn: this.providerArn,\n          credentialLocation: this.credentialLocation.credentialLocationType,\n          credentialParameterName: this.credentialLocation.credentialParameterName,\n          credentialPrefix: this.credentialLocation.credentialPrefix,\n        },\n      },\n    };\n  }\n}\n"]}

package/agentcore/gateway/outbound-auth/credential-provider.d.ts

@@ -0,0 +1,70 @@
+import { IResolvable } from 'aws-cdk-lib';
+import { CfnGatewayTarget } from 'aws-cdk-lib/aws-bedrockagentcore';
+import { ApiKeyCredentialProviderProps } from './api-key';
+import { OAuthConfiguration } from './oauth';
+import { Grant, IRole } from 'aws-cdk-lib/aws-iam';
+/******************************************************************************
+ *                                 Enums
+ *****************************************************************************/
+/**
+ * Credential provider types supported by gateway target
+ */
+export declare enum CredentialProviderType {
+    /**
+     * API Key authentication
+     */
+    API_KEY = "API_KEY",
+    /**
+     * OAuth authentication
+     */
+    OAUTH = "OAUTH",
+    /**
+     * IAM role authentication
+     */
+    GATEWAY_IAM_ROLE = "GATEWAY_IAM_ROLE"
+}
+/******************************************************************************
+ *                       Credential Provider
+ *****************************************************************************/
+/**
+ * Abstract interface for gateway credential provider configuration
+ */
+export interface ICredentialProviderConfig {
+    /**
+     * The credential provider type
+     */
+    readonly credentialProviderType: CredentialProviderType;
+    /**
+     * Renders as CFN Property
+     *  @internal
+     */
+    _render(): CfnGatewayTarget.CredentialProviderConfigurationProperty | IResolvable;
+    /**
+     * Grant the role the permissions
+     */
+    grantNeededPermissionsToRole(role: IRole): Grant | undefined;
+}
+/**
+ * Factory class for creating different Gateway Credential Providers
+ */
+export declare abstract class GatewayCredentialProvider {
+    /**
+     * Create an API key credential provider from Identity ARN
+     * Use this method when you have the Identity ARN as a string
+     * @param props - The configuration properties for the API key credential provider
+     * @returns ICredentialProviderConfig configured for API key authentication
+     */
+    static fromApiKeyIdentityArn(props: ApiKeyCredentialProviderProps): ICredentialProviderConfig;
+    /**
+     * Create an OAuth credential provider from Identity ARN
+     * Use this method when you have the Identity ARN as a string
+     * @param props - The configuration properties for the OAuth credential provider
+     * @returns ICredentialProviderConfig configured for OAuth authentication
+     */
+    static fromOauthIdentityArn(props: OAuthConfiguration): ICredentialProviderConfig;
+    /**
+     * Create an IAM role credential provider
+     * @returns IIamRoleCredentialProvider configured for IAM role authentication
+     */
+    static fromIamRole(): ICredentialProviderConfig;
+}