Package software.amazon.awscdk.services.bedrockagentcore

Interface ApiGatewayTargetConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiGatewayTargetConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-19T08:18:44.215Z")
@Stability(Stable)
public interface ApiGatewayTargetConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for creating an API Gateway target configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.services.bedrockagentcore.*;
 ApiGatewayHttpMethod apiGatewayHttpMethod;
 RestApi restApi;
 ApiGatewayTargetConfigurationProps apiGatewayTargetConfigurationProps = ApiGatewayTargetConfigurationProps.builder()
         .apiGatewayToolConfiguration(ApiGatewayToolConfiguration.builder()
                 .toolFilters(List.of(ApiGatewayToolFilter.builder()
                         .filterPath("filterPath")
                         .methods(List.of(apiGatewayHttpMethod))
                         .build()))
                 // the properties below are optional
                 .toolOverrides(List.of(ApiGatewayToolOverride.builder()
                         .method(apiGatewayHttpMethod)
                         .name("name")
                         .path("path")
                         // the properties below are optional
                         .description("description")
                         .build()))
                 .build())
         .restApi(restApi)
         // the properties below are optional
         .metadataConfiguration(MetadataConfiguration.builder()
                 .allowedQueryParameters(List.of("allowedQueryParameters"))
                 .allowedRequestHeaders(List.of("allowedRequestHeaders"))
                 .allowedResponseHeaders(List.of("allowedResponseHeaders"))
                 .build())
         .stage("stage")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ApiGatewayTargetConfigurationProps.Builder	A builder for ApiGatewayTargetConfigurationProps
static final class	ApiGatewayTargetConfigurationProps.Jsii$Proxy	An implementation for ApiGatewayTargetConfigurationProps

Method Summary

Modifier and Type	Method	Description
static ApiGatewayTargetConfigurationProps.Builder	builder()
ApiGatewayToolConfiguration	getApiGatewayToolConfiguration()	Tool configuration defining which operations to expose.
default MetadataConfiguration	getMetadataConfiguration()	Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.
IRestApi	getRestApi()	The REST API to integrate with Must be in the same account and region as the gateway.
default String	getStage()	The stage name of the REST API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiGatewayToolConfiguration

@Stability(Stable)
@NotNull
ApiGatewayToolConfiguration getApiGatewayToolConfiguration()

Tool configuration defining which operations to expose.

getRestApi

@Stability(Stable)
@NotNull
IRestApi getRestApi()

The REST API to integrate with Must be in the same account and region as the gateway.

getMetadataConfiguration

@Stability(Stable)
@Nullable
default MetadataConfiguration getMetadataConfiguration()

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

Default: - No metadata configuration

getStage

@Stability(Stable)
@Nullable
default String getStage()

The stage name of the REST API.

Default: - Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)

builder

@Stability(Stable)
static ApiGatewayTargetConfigurationProps.Builder builder()

Returns:

a ApiGatewayTargetConfigurationProps.Builder of ApiGatewayTargetConfigurationProps