MetadataConfiguration Struct
Configuration for passing metadata (headers and query parameters) to the API Gateway target.
Example
ts
const gateway = new agentcore.Gateway(this, "MyGateway", {
gatewayName: "my-gateway",
});
const api = new apigateway.RestApi(this, 'MyApi', {
restApiName: 'my-api',
});
// Create a gateway target using the static factory method
const apiGatewayTarget = agentcore.GatewayTarget.forApiGateway(this, "MyApiGatewayTarget", {
gatewayTargetName: "my-api-gateway-target",
description: "Target for API Gateway REST API integration",
gateway: gateway,
restApi: api,
apiGatewayToolConfiguration: {
toolFilters: [
{
filterPath: "/pets/*",
methods: [agentcore.ApiGatewayHttpMethod.GET, agentcore.ApiGatewayHttpMethod.POST],
},
],
},
metadataConfiguration: {
allowedRequestHeaders: ["X-User-Id"],
allowedQueryParameters: ["limit"],
},
});
Properties
allowedQueryParametersoptionalstring[]allowed_query_parametersoptionaltyping.List[str]allowedQueryParametersoptionalList<String>AllowedQueryParametersoptionalstring[]AllowedQueryParametersoptional*[]*string#List of query parameter names to pass through to the target.
Default: No query parameters are passed through
Constraints:
- Array must contain 1-10 items
- Each parameter name must be 1-40 characters
- Cannot be an empty array
allowedRequestHeadersoptionalstring[]allowed_request_headersoptionaltyping.List[str]allowedRequestHeadersoptionalList<String>AllowedRequestHeadersoptionalstring[]AllowedRequestHeadersoptional*[]*string#List of request header names to pass through to the target.
Default: No request headers are passed through
Constraints:
- Array must contain 1-10 items
- Each header name must be 1-100 characters
- Cannot be an empty array
allowedResponseHeadersoptionalstring[]allowed_response_headersoptionaltyping.List[str]allowedResponseHeadersoptionalList<String>AllowedResponseHeadersoptionalstring[]AllowedResponseHeadersoptional*[]*string#List of response header names to pass through from the target.
Default: No response headers are passed through
Constraints:
- Array must contain 1-10 items
- Each header name must be 1-100 characters
- Cannot be an empty array