AddApiGatewayTargetOptions

class aws_cdk.aws_bedrock_agentcore_alpha.AddApiGatewayTargetOptions(*, api_gateway_tool_configuration, rest_api, credential_provider_configurations=None, description=None, gateway_target_name=None, metadata_configuration=None, stage=None)

Bases: object

(experimental) Options for adding an API Gateway target to a gateway.

Parameters:

  • api_gateway_tool_configuration (Union[ApiGatewayToolConfiguration, Dict[str, Any]]) – (experimental) Tool configuration defining which operations to expose.

  • rest_api (IRestApi) – (experimental) The REST API to integrate with Must be in the same account and region as the gateway [disable-awslint:prefer-ref-interface].

  • credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – (experimental) Credential providers for authentication API Gateway targets support IAM and API key authentication. Default: - Empty array (service handles IAM automatically)

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

  • gateway_target_name (Optional[str]) – (experimental) The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen). Default: - auto generate

  • metadata_configuration (Union[MetadataConfiguration, Dict[str, Any], None]) – (experimental) Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters. Default: - No metadata configuration

  • stage (Optional[str]) – (experimental) The stage name of the REST API. Default: - Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)

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
from aws_cdk import aws_apigateway as apigateway

# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
# rest_api: apigateway.RestApi

add_api_gateway_target_options = bedrock_agentcore_alpha.AddApiGatewayTargetOptions(
    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"
        )]
    ),
    rest_api=rest_api,

    # the properties below are optional
    credential_provider_configurations=[credential_provider_config],
    description="description",
    gateway_target_name="gatewayTargetName",
    metadata_configuration=bedrock_agentcore_alpha.MetadataConfiguration(
        allowed_query_parameters=["allowedQueryParameters"],
        allowed_request_headers=["allowedRequestHeaders"],
        allowed_response_headers=["allowedResponseHeaders"]
    ),
    stage="stage"
)

Attributes

api_gateway_tool_configuration

(experimental) Tool configuration defining which operations to expose.

Stability:

experimental

credential_provider_configurations

(experimental) Credential providers for authentication API Gateway targets support IAM and API key authentication.

Default:

  • Empty array (service handles IAM automatically)

Stability:

experimental

description

(experimental) Optional description for the gateway target.

Default:

  • No description

Stability:

experimental

gateway_target_name

(experimental) The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).

Default:

  • auto generate

Stability:

experimental

metadata_configuration

(experimental) Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.

Default:

  • No metadata configuration

Stability:

experimental

rest_api

prefer-ref-interface].

Stability:

experimental

Type:

(experimental) The REST API to integrate with Must be in the same account and region as the gateway [disable-awslint

stage

(experimental) The stage name of the REST API.

Default:

  • Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)

Stability:

experimental