interface IMcpGatewayTarget
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.IMcpGatewayTarget |
 Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#IMcpGatewayTarget |
 Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.IMcpGatewayTarget |
 Python | aws_cdk.aws_bedrock_agentcore_alpha.IMcpGatewayTarget |
 TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » IMcpGatewayTarget |
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Implements
IDependable, IConstruct, IEnvironment, IResource, IGateway, IGateway
Implemented by
Gateway
Interface for MCP gateway targets.
Extends the base gateway target interface with MCP-specific properties. MCP targets expose tools using the Model Context Protocol.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| gateway | IGateway | The gateway that this target belongs to. |
| gateway | Gateway | A reference to a GatewayTarget resource. |
| name | string | The name of the gateway target. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| target | string | The ARN of the gateway target resource. |
| target | string | The id of the gateway target. |
| target | Gateway | The target protocol. |
| target | Mcp | The type of target (Lambda, OpenAPI, or Smithy). |
| created | string | Timestamp when the gateway target was created. |
| credential | ICredential[] | The credential provider configuration for the target. |
| description? | string | The description of the gateway target. |
| status? | string | The status of the gateway target. |
| status | string[] | The status reasons for the gateway target. |
| updated | string | Timestamp when the gateway target was last updated. |
env
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Resource
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
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
IGateway
The gateway that this target belongs to.
gatewayTargetRef
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Gateway
A reference to a GatewayTarget resource.
name
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
The name of the gateway target.
node
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Node
The tree node.
stack
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Stack
The stack in which this resource is defined.
targetArn
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
The ARN of the gateway target resource.
targetId
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
The id of the gateway target.
targetProtocolType
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Gateway
The target protocol.
targetType
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Mcp
The type of target (Lambda, OpenAPI, or Smithy).
createdAt?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional)
Timestamp when the gateway target was created.
credentialProviderConfigurations?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
ICredential[]
(optional)
The credential provider configuration for the target.
description?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional)
The description of the gateway target.
status?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional)
The status of the gateway target.
statusReasons?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string[]
(optional)
The status reasons for the gateway target.
updatedAt?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional)
Timestamp when the gateway target was last updated.
Methods
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
| grant(grantee, ...actions) | Grants IAM actions to the IAM Principal. |
| grant | Grants Create, Update, and Delete actions on the Gateway Target. |
| grant | Grants Get and List actions on the Gateway Target. |
| with(...mixins) | Applies one or more mixins to this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
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
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- grantee
IGrantable - actions
string
Returns
Grants IAM actions to the IAM Principal.
grantManage(grantee)
public grantManage(grantee: IGrantable): Grant
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- grantee
IGrantable
Returns
Grants Create, Update, and Delete actions on the Gateway Target.
grantRead(grantee)
public grantRead(grantee: IGrantable): Grant
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- grantee
IGrantable
Returns
Grants Get and List actions on the Gateway Target.
with(...mixins)
public with(...mixins: IMixin[]): IConstruct
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- mixins
IMixin— The mixins to apply.
Returns
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.