MetadataConfiguration

class aws_cdk.aws_bedrock_agentcore_alpha.MetadataConfiguration(*, allowed_query_parameters=None, allowed_request_headers=None, allowed_response_headers=None)

Bases: object

(experimental) Configuration for passing metadata (headers and query parameters) to the API Gateway target.

Parameters:

  • allowed_query_parameters (Optional[Sequence[str]]) – (experimental) List of query parameter names to pass through to the target. Constraints: - Array must contain 1-10 items - Each parameter name must be 1-40 characters - Cannot be an empty array Default: - No query parameters are passed through

  • allowed_request_headers (Optional[Sequence[str]]) – (experimental) List of request header names to pass through to the target. Constraints: - Array must contain 1-10 items - Each header name must be 1-100 characters - Cannot be an empty array Default: - No request headers are passed through

  • allowed_response_headers (Optional[Sequence[str]]) – (experimental) List of response header names to pass through from the target. Constraints: - Array must contain 1-10 items - Each header name must be 1-100 characters - Cannot be an empty array Default: - No response headers are passed through

Stability:

experimental

ExampleMetadata:

fixture=default infused

Example:

gateway = agentcore.Gateway(self, "MyGateway",
    gateway_name="my-gateway"
)

api = apigateway.RestApi(self, "MyApi",
    rest_api_name="my-api"
)

# Create a gateway target using the static factory method
api_gateway_target = agentcore.GatewayTarget.for_api_gateway(self, "MyApiGatewayTarget",
    gateway_target_name="my-api-gateway-target",
    description="Target for API Gateway REST API integration",
    gateway=gateway,
    rest_api=api,
    api_gateway_tool_configuration=agentcore.ApiGatewayToolConfiguration(
        tool_filters=[agentcore.ApiGatewayToolFilter(
            filter_path="/pets/*",
            methods=[agentcore.ApiGatewayHttpMethod.GET, agentcore.ApiGatewayHttpMethod.POST]
        )
        ]
    ),
    metadata_configuration=agentcore.MetadataConfiguration(
        allowed_request_headers=["X-User-Id"],
        allowed_query_parameters=["limit"]
    )
)

Attributes

allowed_query_parameters

(experimental) List of query parameter names to pass through to the target.

Constraints:

  • Array must contain 1-10 items

  • Each parameter name must be 1-40 characters

  • Cannot be an empty array

Default:

  • No query parameters are passed through

Stability:

experimental

allowed_request_headers

(experimental) List of request header names to pass through to the target.

Constraints:

  • Array must contain 1-10 items

  • Each header name must be 1-100 characters

  • Cannot be an empty array

Default:

  • No request headers are passed through

Stability:

experimental

allowed_response_headers

(experimental) List of response header names to pass through from the target.

Constraints:

  • Array must contain 1-10 items

  • Each header name must be 1-100 characters

  • Cannot be an empty array

Default:

  • No response headers are passed through

Stability:

experimental