ApiGatewayToolOverride

class aws_cdk.aws_bedrockagentcore.ApiGatewayToolOverride(*, method, name, path, description=None)

Bases: object

Configuration for overriding API Gateway tool metadata.

Tool overrides allow you to customize the tool name or description for specific operations after filtering. Each override must specify an explicit path and a single HTTP method. The override must match an operation that exists in your API and must correspond to one of the operations resolved by your filters.

Parameters:

method (ApiGatewayHttpMethod) – The HTTP method for this override Must be a single method (no wildcards).
name (str) – The custom tool name If not provided, the operationId from the OpenAPI definition will be used.
path (str) – The explicit resource path (no wildcards) Must match an operation that exists in your API.
description (Optional[str]) – Optional custom description for the tool. Default: - No custom description

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

# api_gateway_http_method: bedrockagentcore.ApiGatewayHttpMethod

api_gateway_tool_override = bedrockagentcore.ApiGatewayToolOverride(
    method=api_gateway_http_method,
    name="name",
    path="path",

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

Attributes

description

Optional custom description for the tool.

Default:

No custom description

method: The HTTP method for this override Must be a single method (no wildcards).

name: The custom tool name If not provided, the operationId from the OpenAPI definition will be used.

path: The explicit resource path (no wildcards) Must match an operation that exists in your API.