2.256.1

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

Implements GatewayTargetCommonProps

Properties for creating a Smithy-based Gateway Target.

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 apiSchema: bedrock_agentcore_alpha.ApiSchema;
declare const credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
declare const gateway: bedrock_agentcore_alpha.Gateway;
const gatewayTargetSmithyProps: bedrock_agentcore_alpha.GatewayTargetSmithyProps = {
  gateway: gateway,
  smithyModel: apiSchema,

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

Properties

NameTypeDescription
gateway🔹IGatewayThe gateway this target belongs to.
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.
gatewayTargetName?🔹stringThe name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

gateway🔹

Type: IGateway

The gateway this target belongs to.

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.

gatewayTargetName?🔹

Type: string (optional, default: auto generate)

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

← PreviousNext →