ApiGatewayToolFilter
- class aws_cdk.aws_bedrock_agentcore_alpha.ApiGatewayToolFilter(*, filter_path, methods)
Bases:
object(experimental) Configuration for filtering API Gateway tools.
Tool filters allow you to select REST API operations using path and method combinations. Each filter supports two path matching strategies:
Explicit paths: Matches a single specific path, such as
/pets/{petId}Wildcard paths: Matches all paths starting with the specified prefix, such as
/pets/*
- Parameters:
filter_path (
str) – (experimental) The resource path to filter Can be an explicit path (e.g.,/pets/{petId}) or a wildcard path (e.g.,/pets/*) Must start with a forward slash.methods (
Sequence[ApiGatewayHttpMethod]) – (experimental) List of HTTP methods to include for this path Each filter specifies both a path and a list of HTTP methods Multiple filters can overlap and duplicates are automatically de-duplicated.
- Stability:
experimental
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha api_gateway_tool_filter = bedrock_agentcore_alpha.ApiGatewayToolFilter( filter_path="filterPath", methods=[bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET] )
Attributes
- filter_path
(experimental) The resource path to filter Can be an explicit path (e.g.,
/pets/{petId}) or a wildcard path (e.g.,/pets/*) Must start with a forward slash.- Stability:
experimental
- methods
(experimental) List of HTTP methods to include for this path Each filter specifies both a path and a list of HTTP methods Multiple filters can overlap and duplicates are automatically de-duplicated.
- Stability:
experimental