interface GatewayTargetProps 🔹

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

Implements GatewayTargetCommonProps

Properties for creating a Gateway Target resource.

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 gatewayTargetProps: bedrock_agentcore_alpha.GatewayTargetProps = {
  gateway: gateway,
  targetConfiguration: targetConfiguration,

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

Properties

Name	Type	Description
gateway🔹	IGateway	The gateway this target belongs to.
targetConfiguration🔹	ITargetConfiguration	The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes: - LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create().
credentialProviderConfigurations?🔹	ICredentialProviderConfig[]	Credential providers for authentication.
description?🔹	string	Optional description for the gateway target The description can have up to 200 characters.
gatewayTargetName?🔹	string	The 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.

---

targetConfiguration🔹

Type: ITargetConfiguration

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

---

credentialProviderConfigurations?🔹

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

Credential providers for 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}$.