interface AddSmithyTargetOptions 🔹

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

Options for adding a Smithy target to a gateway.

Example


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

const smithySchema = agentcore.ApiSchema.fromLocalAsset(
  path.join(__dirname, "models", "smithy-model.json")
);
smithySchema.bind(this);

const smithyTarget = gateway.addSmithyTarget("MySmithyTarget", {
  gatewayTargetName: "my-smithy-target",
  description: "Smithy model target",
  smithyModel: smithySchema,

});

Properties

Name	Type	Description
gatewayTargetName🔹	`string`	The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).
smithyModel🔹	`ApiSchema`	The Smithy model defining the API.
credentialProviderConfigurations?🔹	`ICredentialProviderConfig[]`	Credential providers for authentication.
description?🔹	`string`	Optional description for the gateway target.

gatewayTargetName🔹

Type: string

The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).

smithyModel🔹

Type: ApiSchema

The Smithy model defining the API.

credentialProviderConfigurations?🔹

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

Credential providers for authentication.

description?🔹

Type: string (optional, default: No description)

Optional description for the gateway target.