2.248.0

interface GatewayTargetApiGatewayProps 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Agentcore.Alpha.GatewayTargetApiGatewayProps
Gogithub.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#GatewayTargetApiGatewayProps
Javasoftware.amazon.awscdk.services.bedrock.agentcore.alpha.GatewayTargetApiGatewayProps
Pythonaws_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

const gateway = new agentcore.Gateway(this, "MyGateway", {
  gatewayName: "my-gateway",
});

const api = new apigateway.RestApi(this, 'MyApi', {
  restApiName: 'my-api',
});

// Create a gateway target using the static factory method
const apiGatewayTarget = agentcore.GatewayTarget.forApiGateway(this, "MyApiGatewayTarget", {
  gatewayTargetName: "my-api-gateway-target",
  description: "Target for API Gateway REST API integration",
  gateway: gateway,
  restApi: api,
  apiGatewayToolConfiguration: {
    toolFilters: [
      {
        filterPath: "/pets/*",
        methods: [agentcore.ApiGatewayHttpMethod.GET, agentcore.ApiGatewayHttpMethod.POST],
      },
    ],
  },
  metadataConfiguration: {
    allowedRequestHeaders: ["X-User-Id"],
    allowedQueryParameters: ["limit"],
  },
});

Properties

NameTypeDescription
apiGatewayToolConfiguration🔹ApiGatewayToolConfigurationTool configuration defining which operations to expose.
gateway🔹IGatewayThe gateway this target belongs to [disable-awslint:prefer-ref-interface].
restApi🔹IRestApiThe 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?🔹stringOptional description for the gateway target The description can have up to 200 characters.
gatewayTargetName?🔹stringThe name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.
metadataConfiguration?🔹MetadataConfigurationMetadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.
stage?🔹stringThe 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.

← PreviousNext →