ApiGatewayToolConfiguration

class aws_cdk.aws_bedrock_agentcore_alpha.ApiGatewayToolConfiguration(*, tool_filters, tool_overrides=None)

Bases: object

(experimental) Configuration for API Gateway tools.

The API Gateway tool configuration defines which operations from your REST API are exposed as tools. It requires a list of tool filters to select operations to expose, and optionally accepts tool overrides to customize tool metadata.

Parameters:

• tool_filters (Sequence[Union[ApiGatewayToolFilter, Dict[str, Any]]]) – (experimental) List of tool filters to select operations At least one filter is required.

• tool_overrides (Optional[Sequence[Union[ApiGatewayToolOverride, Dict[str, Any]]]]) – (experimental) Optional list of tool overrides to customize tool metadata Each override must correspond to an operation selected by the filters. Default: - No tool overrides

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_configuration = bedrock_agentcore_alpha.ApiGatewayToolConfiguration(
    tool_filters=[bedrock_agentcore_alpha.ApiGatewayToolFilter(
        filter_path="filterPath",
        methods=[bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET]
    )],

    # the properties below are optional
    tool_overrides=[bedrock_agentcore_alpha.ApiGatewayToolOverride(
        method=bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET,
        name="name",
        path="path",

        # the properties below are optional
        description="description"
    )]
)

Attributes

tool_filters

(experimental) List of tool filters to select operations At least one filter is required.

Stability:

experimental

tool_overrides

(experimental) Optional list of tool overrides to customize tool metadata Each override must correspond to an operation selected by the filters.

Default:

• No tool overrides

Stability:

experimental