Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

GatewayTarget L2 construct

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

Stability: Experimental
CloudFormation: AWS::BedrockAgentCore::GatewayTarget
L1 type: CfnGatewayTarget
Source: lib/gateway/targets/target.ts

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';

declare const credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
declare const gateway: bedrock_agentcore_alpha.Gateway;
declare const targetConfiguration: bedrock_agentcore_alpha.ITargetConfiguration;
const gatewayTarget = new bedrock_agentcore_alpha.GatewayTarget(this, 'MyGatewayTarget', {
  gateway: gateway,
  targetConfiguration: targetConfiguration,

  // the properties below are optional
  credentialProviderConfigurations: [credentialProviderConfig],
  description: 'description',
  gatewayTargetName: 'gatewayTargetName',
});

python

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
# gateway: bedrock_agentcore_alpha.Gateway
# target_configuration: bedrock_agentcore_alpha.ITargetConfiguration

gateway_target = bedrock_agentcore_alpha.GatewayTarget(self, "MyGatewayTarget",
    gateway=gateway,
    target_configuration=target_configuration,

    # the properties below are optional
    credential_provider_configurations=[credential_provider_config],
    description="description",
    gateway_target_name="gatewayTargetName"
)

java

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;

ICredentialProviderConfig credentialProviderConfig;
Gateway gateway;
ITargetConfiguration targetConfiguration;

GatewayTarget gatewayTarget = GatewayTarget.Builder.create(this, "MyGatewayTarget")
        .gateway(gateway)
        .targetConfiguration(targetConfiguration)

        // the properties below are optional
        .credentialProviderConfigurations(List.of(credentialProviderConfig))
        .description("description")
        .gatewayTargetName("gatewayTargetName")
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;

ICredentialProviderConfig credentialProviderConfig;
Gateway gateway;
ITargetConfiguration targetConfiguration;

var gatewayTarget = new GatewayTarget(this, "MyGatewayTarget", new GatewayTargetProps {
    Gateway = gateway,
    TargetConfiguration = targetConfiguration,

    // the properties below are optional
    CredentialProviderConfigurations = new [] { credentialProviderConfig },
    Description = "description",
    GatewayTargetName = "gatewayTargetName"
});

// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"

var credentialProviderConfig ICredentialProviderConfig
var gateway Gateway
var targetConfiguration ITargetConfiguration

gatewayTarget := bedrock_agentcore_alpha.NewGatewayTarget(this, jsii.String("MyGatewayTarget"), &GatewayTargetProps{
	Gateway: gateway,
	TargetConfiguration: targetConfiguration,

	// the properties below are optional
	CredentialProviderConfigurations: []ICredentialProviderConfig{
		credentialProviderConfig,
	},
	Description: jsii.String("description"),
	GatewayTargetName: jsii.String("gatewayTargetName"),
})

Initializer

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

python

GatewayTarget(scope: Construct, id: str, props: GatewayTargetProps)

java

new GatewayTarget(Construct scope, String id, GatewayTargetProps props)

csharp

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

NewGatewayTarget(Scope Construct, Id *string, Props GatewayTargetProps)

Construct Props

credentialProviderConfigurationsoptionalICredentialProviderConfig[]credential_provider_configurationsoptionaltyping.List[ICredentialProviderConfig]credentialProviderConfigurationsoptionalList<ICredentialProviderConfig>CredentialProviderConfigurationsoptionalICredentialProviderConfig[]CredentialProviderConfigurationsoptional*[]ICredentialProviderConfig#

Credential providers for authentication.

Default: [GatewayCredentialProvider.fromIamRole()]

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#

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

Default: No description

gatewayIGatewaygatewayIGatewaygatewayIGatewayGatewayIGatewayGatewayIGatewayrequired#

The gateway this target belongs to.

gatewayTargetNameoptionalstringgateway_target_nameoptionalstrgatewayTargetNameoptionalStringGatewayTargetNameoptionalstringGatewayTargetNameoptional*string#

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

Default: auto generate

targetConfigurationITargetConfigurationtarget_configurationITargetConfigurationtargetConfigurationITargetConfigurationTargetConfigurationITargetConfigurationTargetConfigurationITargetConfigurationrequired#

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

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 providers for this target.

descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#

Optional description for the gateway target.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

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 this target belongs to.

gatewayTargetRefGatewayTargetReferencegateway_target_refGatewayTargetReferencegatewayTargetRefGatewayTargetReferenceGatewayTargetRefGatewayTargetReferenceGatewayTargetRefGatewayTargetReferencerequired#

A reference to a GatewayTarget resource.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the gateway target.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

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.

targetIdstringtarget_idstrtargetIdStringTargetIdstringTargetId*stringrequired#

The unique identifier of the gateway target.

targetProtocolTypeGatewayTargetProtocolTypetarget_protocol_typeGatewayTargetProtocolTypetargetProtocolTypeGatewayTargetProtocolTypeTargetProtocolTypeGatewayTargetProtocolTypeTargetProtocolTypeGatewayTargetProtocolTyperequired#

The protocol type (always MCP for now).

targetTypeMcpTargetTypetarget_typeMcpTargetTypetargetTypeMcpTargetTypeTargetTypeMcpTargetTypeTargetTypeMcpTargetTyperequired#

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

updatedAtmay be undefinedstringupdated_atmay be undefinedstrupdatedAtmay be undefinedStringUpdatedAtmay be undefinedstringUpdatedAtmay be undefined*string#

Timestamp when the gateway target was last updated.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

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).

forApiGateway(scope: Construct, id: string, props: GatewayTargetApiGatewayProps): GatewayTarget // chainable@staticmethod def for_api_gateway(scope: Construct, id: str, props: GatewayTargetApiGatewayProps) -> GatewayTargetpublic static GatewayTarget forApiGateway(Construct scope, String id, GatewayTargetApiGatewayProps props)public static GatewayTarget ForApiGateway(Construct scope, string id, GatewayTargetApiGatewayProps props)func ForApiGateway(Scope Construct, Id *string, Props GatewayTargetApiGatewayProps) GatewayTargetstatic#

Create an API Gateway-based target Convenience method for creating a target that connects to an API Gateway REST API.

3 parameters · returns

Parameters

scopescopescopescopeScope — The construct scope.
ididididId — The construct id.
propspropspropspropsProps — The properties for the API Gateway target.