Skip to content
v2.274.0

IMcpGatewayTarget Interface ​

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 ​

createdAtmay be undefinedstringcreated_atmay be undefinedstrcreatedAtmay be undefinedStringCreatedAtmay be undefinedstringCreatedAtmay be undefined*string#
Timestamp when the gateway target was created.
credentialProviderConfigurationsmay be undefinedICredentialProviderConfig[]credential_provider_configurationsmay be undefinedtyping.List[ICredentialProviderConfig]credentialProviderConfigurationsmay be undefinedList<ICredentialProviderConfig>CredentialProviderConfigurationsmay be undefinedICredentialProviderConfig[]CredentialProviderConfigurationsmay be undefined*[]ICredentialProviderConfig#
The credential provider configuration for the target.
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#
The description of the gateway target.
The environment this resource belongs to.
notes

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.

gatewayIGatewaygatewayIGatewaygatewayIGatewayGatewayIGatewayGatewayIGatewayrequired#
The gateway that this target belongs to.
gatewayTargetNamestringgateway_target_namestrgatewayTargetNameStringGatewayTargetNamestringGatewayTargetName*stringrequired#
The name of the gateway target.
gatewayTargetRefGatewayTargetReferencegateway_target_refGatewayTargetReferencegatewayTargetRefGatewayTargetReferenceGatewayTargetRefGatewayTargetReferenceGatewayTargetRefGatewayTargetReferencerequired#
A reference to a GatewayTarget resource.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.
statusmay be undefinedstringstatusmay be undefinedstrstatusmay be undefinedStringStatusmay be undefinedstringStatusmay be undefined*string#
The status of the gateway target.
statusReasonsmay be undefinedstring[]status_reasonsmay be undefinedtyping.List[str]statusReasonsmay be undefinedList<String>StatusReasonsmay be undefinedstring[]StatusReasonsmay be undefined*[]*string#
The status reasons for the gateway target.
targetArnstringtarget_arnstrtargetArnStringTargetArnstringTargetArn*stringrequired#
The ARN of the gateway target resource.
targetIdstringtarget_idstrtargetIdStringTargetIdstringTargetId*stringrequired#
The id of the gateway target.
targetProtocolTypeGatewayTargetProtocolTypetarget_protocol_typeGatewayTargetProtocolTypetargetProtocolTypeGatewayTargetProtocolTypeTargetProtocolTypeGatewayTargetProtocolTypeTargetProtocolTypeGatewayTargetProtocolTyperequired#
The target protocol.
targetTypeMcpTargetTypetarget_typeMcpTargetTypetargetTypeMcpTargetTypeTargetTypeMcpTargetTypeTargetTypeMcpTargetTyperequired#
The type of target (Lambda, OpenAPI, or Smithy).
updatedAtmay be undefinedstringupdated_atmay be undefinedstrupdatedAtmay be undefinedStringUpdatedAtmay be undefinedstringUpdatedAtmay be undefined*string#
Timestamp when the gateway target was last updated.

Methods ​

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

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: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#
Grants IAM actions to the IAM Principal.
grantManage(grantee: IGrantable): Grantdef grant_manage(self, grantee: IGrantable) -> Grantpublic Grant grantManage(IGrantable grantee)public Grant GrantManage(IGrantable grantee)func GrantManage(Grantee IGrantable) Grant#
Grants `Create`, `Update`, and `Delete` actions on the Gateway Target.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#
Grants `Get` and `List` actions on the Gateway Target.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
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.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining