Skip to content
v2.278.0

SmithyTargetConfiguration Class ​

Configuration for Smithy-based MCP targets.

This configuration exposes a Smithy-modeled API as MCP tools, allowing the gateway to transform Smithy operations into tool calls.

Example ​

ts
// 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 apiSchema: bedrock_agentcore_alpha.ApiSchema;
const smithyTargetConfiguration = new bedrock_agentcore_alpha.SmithyTargetConfiguration(apiSchema);
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

# api_schema: bedrock_agentcore_alpha.ApiSchema

smithy_target_configuration = bedrock_agentcore_alpha.SmithyTargetConfiguration(api_schema)
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.*;

ApiSchema apiSchema;

SmithyTargetConfiguration smithyTargetConfiguration = new SmithyTargetConfiguration(apiSchema);
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;

ApiSchema apiSchema;

var smithyTargetConfiguration = new SmithyTargetConfiguration(apiSchema);
go
// 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 apiSchema ApiSchema

smithyTargetConfiguration := bedrock_agentcore_alpha.NewSmithyTargetConfiguration(apiSchema)

Initializer ​

ts
new SmithyTargetConfiguration(smithyModel: ApiSchema)
python
SmithyTargetConfiguration(smithy_model: ApiSchema)
java
new SmithyTargetConfiguration(ApiSchema smithyModel)
csharp
new SmithyTargetConfiguration(ApiSchema smithyModel)
go
NewSmithyTargetConfiguration(SmithyModel ApiSchema)

Properties ​

smithyModelApiSchemasmithy_modelApiSchemasmithyModelApiSchemaSmithyModelApiSchemaSmithyModelApiSchema #
The Smithy model that defines the API.
targetTypeMcpTargetTypetarget_typeMcpTargetTypetargetTypeMcpTargetTypeTargetTypeMcpTargetTypeTargetTypeMcpTargetType #
The target type.

Methods ​

bind(scope: Construct, gateway: IGateway): TargetConfigurationConfigdef bind(self, scope: Construct, gateway: IGateway) -> TargetConfigurationConfigpublic TargetConfigurationConfig bind(Construct scope, IGateway gateway)public TargetConfigurationConfig Bind(Construct scope, IGateway gateway)func Bind(Scope Construct, Gateway IGateway) TargetConfigurationConfig #
Binds this configuration to a construct scope Sets up necessary permissions for the gateway to access the Smithy model.
2 parameters

Parameters

  • scopescopescopescopeScope — The construct scope.
  • gatewaygatewaygatewaygatewayGateway — The gateway that will use this target.
create(smithyModel: ApiSchema): SmithyTargetConfiguration // chainable@staticmethod def create(smithy_model: ApiSchema) -> SmithyTargetConfigurationpublic static SmithyTargetConfiguration create(ApiSchema smithyModel)public static SmithyTargetConfiguration Create(ApiSchema smithyModel)func Create(SmithyModel ApiSchema) SmithyTargetConfiguration static #
Create a Smithy target configuration.
1 parameter · returns

Parameters

  • smithyModelsmithy_modelsmithyModelsmithyModelSmithyModel — The Smithy model schema.

Returns: A new SmithyTargetConfiguration instance