2.227.0

interface GatewayTargetSmithyProps 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Agentcore.Alpha.GatewayTargetSmithyProps
Gogithub.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#GatewayTargetSmithyProps
Javasoftware.amazon.awscdk.services.bedrock.agentcore.alpha.GatewayTargetSmithyProps
Pythonaws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetSmithyProps
TypeScript (source)@aws-cdk/aws-bedrock-agentcore-alpha » GatewayTargetSmithyProps

Properties for creating a Smithy-based Gateway Target.

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

// Create a gateway target with Smithy Model and OAuth
const target = agentcore.GatewayTarget.forSmithy(this, "MySmithyTarget", {
  gatewayTargetName: "my-smithy-target",
  description: "Target for Smithy model integration",
  gateway: gateway,
  smithyModel: smithySchema,
});

Properties

NameTypeDescription
gateway🔹IGatewayThe gateway this target belongs to.
gatewayTargetName🔹stringThe name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.
smithyModel🔹ApiSchemaThe Smithy model defining the API.
credentialProviderConfigurations?🔹ICredentialProviderConfig[]Credential providers for authentication Smithy targets only support IAM role authentication.
description?🔹stringOptional description for the gateway target The description can have up to 200 characters.

gateway🔹

Type: IGateway

The gateway this target belongs to.

gatewayTargetName🔹

Type: string

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

smithyModel🔹

Type: ApiSchema

The Smithy model defining the API.

credentialProviderConfigurations?🔹

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

Credential providers for authentication Smithy targets only support IAM role authentication.

description?🔹

Type: string (optional, default: No description)

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

← PreviousNext →