interface GatewayTargetApiGatewayProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.GatewayTargetApiGatewayProps
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#GatewayTargetApiGatewayProps
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.GatewayTargetApiGatewayProps
Python	aws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetApiGatewayProps
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » GatewayTargetApiGatewayProps

Implements GatewayTargetCommonProps

Properties for creating an API Gateway-based Gateway Target.

Example

// 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 credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
declare const gateway: bedrock_agentcore_alpha.Gateway;
declare const restApi: apigateway.RestApi;
const gatewayTargetApiGatewayProps: bedrock_agentcore_alpha.GatewayTargetApiGatewayProps = {
  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',
    }],
  },
  gateway: gateway,
  restApi: restApi,

  // the properties below are optional
  credentialProviderConfigurations: [credentialProviderConfig],
  description: 'description',
  gatewayTargetName: 'gatewayTargetName',
  metadataConfiguration: {
    allowedQueryParameters: ['allowedQueryParameters'],
    allowedRequestHeaders: ['allowedRequestHeaders'],
    allowedResponseHeaders: ['allowedResponseHeaders'],
  },
  stage: 'stage',
};

Properties

Name	Type	Description
apiGatewayToolConfiguration🔹	ApiGatewayToolConfiguration	Tool configuration defining which operations to expose.
gateway🔹	IGateway	The gateway this target belongs to [disable-awslint:prefer-ref-interface].
restApi🔹	IRestApi	The REST API to integrate with Must be in the same account and region as the gateway [disable-awslint:prefer-ref-interface].
credentialProviderConfigurations?🔹	ICredentialProviderConfig[]	Credential providers for authentication API Gateway targets support IAM and API key authentication.
description?🔹	string	Optional description for the gateway target The description can have up to 200 characters.
gatewayTargetName?🔹	string	The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.
metadataConfiguration?🔹	MetadataConfiguration	Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.
stage?🔹	string	The stage name of the REST API.

---

apiGatewayToolConfiguration🔹

Type: ApiGatewayToolConfiguration

Tool configuration defining which operations to expose.

---

gateway🔹

Type: IGateway

The gateway this target belongs to [disable-awslint:prefer-ref-interface].

---

restApi🔹

Type: IRestApi

The REST API to integrate with Must be in the same account and region as the gateway [disable-awslint:prefer-ref-interface].

---

credentialProviderConfigurations?🔹

Type: ICredentialProviderConfig[] (optional, default: Empty array (service handles IAM automatically))

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

---

description?🔹

Type: string (optional, default: No description)

Optional description for the gateway target The description can have up to 200 characters.

---

gatewayTargetName?🔹

Type: string (optional, default: auto generate)

The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

---

metadataConfiguration?🔹

Type: MetadataConfiguration (optional, default: No metadata configuration)

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

---

stage?🔹

Type: string (optional, default: Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName))

The stage name of the REST API.