ApiGatewayToolOverride

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

Bases: object

(experimental) 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) – (experimental) The HTTP method for this override Must be a single method (no wildcards).

• name (str) – (experimental) The custom tool name If not provided, the operationId from the OpenAPI definition will be used.

• path (str) – (experimental) The explicit resource path (no wildcards) Must match an operation that exists in your API.

• description (Optional[str]) – (experimental) Optional custom description for the tool. Default: - No custom description

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_override = bedrock_agentcore_alpha.ApiGatewayToolOverride(
    method=bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET,
    name="name",
    path="path",

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

Attributes

description

(experimental) Optional custom description for the tool.

Default:

• No custom description

Stability:

experimental

method

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

Stability:

experimental

name

(experimental) The custom tool name If not provided, the operationId from the OpenAPI definition will be used.

Stability:

experimental

path

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

Stability:

experimental