class GatewayTarget (construct) 🔹

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IGatewayTarget, IMcpGatewayTarget

Defines tools that your gateway will host.

Supports multiple target types:

• Lambda: Wraps a Lambda function as MCP tools
• OpenAPI: Exposes an OpenAPI/REST API as MCP tools
• Smithy: Exposes a Smithy-modeled API as MCP tools

See also: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building-adding-targets.html

Example

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

const lambdaFunction = new lambda.Function(this, "MyFunction", {
  runtime: lambda.Runtime.NODEJS_22_X,
  handler: "index.handler",
  code: lambda.Code.fromInline(`
        exports.handler = async (event) => {
            return {
                statusCode: 200,
                body: JSON.stringify({ message: 'Hello from Lambda!' })
            };
        };
    `),
});

// Create a gateway target with Lambda and tool schema
const target = agentcore.GatewayTarget.forLambda(this, "MyLambdaTarget", {
  gatewayTargetName: "my-lambda-target",
  description: "Target for Lambda function integration",
  gateway: gateway,
  lambdaFunction: lambdaFunction,
  toolSchema: agentcore.ToolSchema.fromLocalAsset(
    path.join(__dirname, "schemas", "my-tool-schema.json")
  ),
});

Initializer

new GatewayTarget(scope: Construct, id: string, props: GatewayTargetProps)

Parameters

• scope Construct
• id string
• props GatewayTargetProps

Construct Props

Name	Type	Description
gateway🔹	IGateway	The gateway this target belongs to.
gatewayTargetName🔹	string	The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.
targetConfiguration🔹	ITargetConfiguration	The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes: - LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create().
credentialProviderConfigurations?🔹	ICredentialProviderConfig[]	Credential providers for authentication.
description?🔹	string	Optional description for the gateway target The description can have up to 200 characters.

---

gateway🔹

Type: IGateway

The gateway this target belongs to.

---

gatewayTargetName🔹

Type: string

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

---

targetConfiguration🔹

Type: ITargetConfiguration

The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes: - LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create().

---

credentialProviderConfigurations?🔹

Type: ICredentialProviderConfig[] (optional, default: [GatewayCredentialProvider.fromIamRole()])

Credential providers for authentication.

---

description?🔹

Type: string (optional, default: No description)

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

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
gateway🔹	IGateway	The gateway this target belongs to.
name🔹	string	The name of the gateway target.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
targetArn🔹	string	The ARN of the gateway target.
targetId🔹	string	The unique identifier of the gateway target.
targetProtocolType🔹	GatewayTargetProtocolType	The protocol type (always MCP for now).
targetType🔹	McpTargetType	The specific MCP target type (Lambda, OpenAPI, Smithy, or MCP Server).
createdAt?🔹	string	Timestamp when the gateway target was created.
credentialProviderConfigurations?🔹	ICredentialProviderConfig[]	The credential providers for this target.
description?🔹	string	Optional description for the gateway target.
status?🔹	string	The status of the gateway target.
statusReasons?🔹	string[]	The status reasons for the gateway target.
updatedAt?🔹	string	Timestamp when the gateway target was last updated.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

gateway🔹

Type: IGateway

The gateway this target belongs to.

---

name🔹

Type: string

The name of the gateway target.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

targetArn🔹

Type: string

The ARN of the gateway target.

---

targetId🔹

Type: string

The unique identifier of the gateway target.

---

targetProtocolType🔹

Type: GatewayTargetProtocolType

The protocol type (always MCP for now).

---

targetType🔹

Type: McpTargetType

The specific MCP target type (Lambda, OpenAPI, Smithy, or MCP Server).

---

createdAt?🔹

Type: string (optional)

Timestamp when the gateway target was created.

---

credentialProviderConfigurations?🔹

Type: ICredentialProviderConfig[] (optional)

The credential providers for this target.

---

description?🔹

Type: string (optional)

Optional description for the gateway target.

---

status?🔹

Type: string (optional)

The status of the gateway target.

---

statusReasons?🔹

Type: string[] (optional)

The status reasons for the gateway target.

---

updatedAt?🔹

Type: string (optional)

Timestamp when the gateway target was last updated.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grants IAM actions to the IAM Principal.
grantManage(grantee)🔹	Grants Create, Update, and Delete actions on the Gateway Target.
grantRead(grantee)🔹	Grants Get and List actions on the Gateway Target.
grantSync(grantee)🔹	Grants permission to synchronize this gateway's targets.
toString()🔹	Returns a string representation of this construct.
static forLambda(scope, id, props)🔹	Create a Lambda-based MCP target Convenience method for creating a target that wraps a Lambda function.
static forMcpServer(scope, id, props)🔹	Create an MCP Server-based target Convenience method for creating a target that connects to an external MCP server.
static forOpenApi(scope, id, props)🔹	Create an OpenAPI-based MCP target Convenience method for creating a target that exposes an OpenAPI/REST API.
static forSmithy(scope, id, props)🔹	Create a Smithy-based MCP target Convenience method for creating a target that exposes a Smithy-modeled API.
static fromGatewayTargetAttributes(scope, id, attrs)🔹	Import an existing Gateway Target using its attributes This allows you to reference a Gateway Target that was created outside of CDK.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal to grant permissions to.
• actions string — The IAM actions to grant.

Returns

• Grant

Grants IAM actions to the IAM Principal.

---

grantManage(grantee)🔹

public grantManage(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant manage permissions to.

Returns

• Grant

Grants Create, Update, and Delete actions on the Gateway Target.

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant read permissions to.

Returns

• Grant

Grants Get and List actions on the Gateway Target.

---

grantSync(grantee)🔹

public grantSync(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants permission to synchronize this gateway's targets.

This method grants the SynchronizeGatewayTargets permission, which is primarily needed for MCP Server targets when you need to refresh the tool catalog after the MCP server's tools have changed.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static forLambda(scope, id, props)🔹

public static forLambda(scope: Construct, id: string, props: GatewayTargetLambdaProps): GatewayTarget

Parameters

• scope Construct — The construct scope.
• id string — The construct id.
• props GatewayTargetLambdaProps — The properties for the Lambda target.

Returns

• GatewayTarget

Create a Lambda-based MCP target Convenience method for creating a target that wraps a Lambda function.

---

static forMcpServer(scope, id, props)🔹

public static forMcpServer(scope: Construct, id: string, props: GatewayTargetMcpServerProps): GatewayTarget

Parameters

• scope Construct — The construct scope.
• id string — The construct id.
• props GatewayTargetMcpServerProps — The properties for the MCP server target.

Returns

• GatewayTarget

Create an MCP Server-based target Convenience method for creating a target that connects to an external MCP server.

See also: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-target-MCPservers.html

---

static forOpenApi(scope, id, props)🔹

public static forOpenApi(scope: Construct, id: string, props: GatewayTargetOpenApiProps): GatewayTarget

Parameters

• scope Construct — The construct scope.
• id string — The construct id.
• props GatewayTargetOpenApiProps — The properties for the OpenAPI target.

Returns

• GatewayTarget

Create an OpenAPI-based MCP target Convenience method for creating a target that exposes an OpenAPI/REST API.

---

static forSmithy(scope, id, props)🔹

public static forSmithy(scope: Construct, id: string, props: GatewayTargetSmithyProps): GatewayTarget

Parameters

• scope Construct — The construct scope.
• id string — The construct id.
• props GatewayTargetSmithyProps — The properties for the Smithy target.

Returns

• GatewayTarget

Create a Smithy-based MCP target Convenience method for creating a target that exposes a Smithy-modeled API.

---

static fromGatewayTargetAttributes(scope, id, attrs)🔹

public static fromGatewayTargetAttributes(scope: Construct, id: string, attrs: GatewayTargetAttributes): IGatewayTarget

Parameters

• scope Construct — The construct scope.
• id string — The construct id.
• attrs GatewayTargetAttributes — The attributes of the existing Gateway Target.

Returns

• IGatewayTarget

Import an existing Gateway Target using its attributes This allows you to reference a Gateway Target that was created outside of CDK.