Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ApiGatewayTargetConfigurationProps Struct
Properties for creating an API Gateway target configuration.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
declare const restApi: apigateway.RestApi;
const apiGatewayTargetConfigurationProps: bedrock_agentcore_alpha.ApiGatewayTargetConfigurationProps = {
apiGatewayToolConfiguration: {
toolFilters: [{
filterPath: 'filterPath',
methods: [bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET],
}],
// the properties below are optional
toolOverrides: [{
method: bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET,
name: 'name',
path: 'path',
// the properties below are optional
description: 'description',
}],
},
restApi: restApi,
// the properties below are optional
metadataConfiguration: {
allowedQueryParameters: ['allowedQueryParameters'],
allowedRequestHeaders: ['allowedRequestHeaders'],
allowedResponseHeaders: ['allowedResponseHeaders'],
},
stage: 'stage',
};
Properties
apiGatewayToolConfigurationApiGatewayToolConfigurationapi_gateway_tool_configurationApiGatewayToolConfigurationapiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationrequired#Tool configuration defining which operations to expose.
metadataConfigurationMetadataConfigurationmetadata_configurationMetadataConfigurationmetadataConfigurationMetadataConfigurationMetadataConfigurationMetadataConfigurationMetadataConfigurationMetadataConfiguration#Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.
Default: No metadata configuration
The REST API to integrate with Must be in the same account and region as the gateway.
The stage name of the REST API.
Default: Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)