AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AddMcpServerTargetOptions Struct ​

Options for adding an MCP Server target to a gateway.

Source
lib/gateway/gateway.ts

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 credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
const addMcpServerTargetOptions: bedrock_agentcore_alpha.AddMcpServerTargetOptions = {
  credentialProviderConfigurations: [credentialProviderConfig],
  endpoint: 'endpoint',

  // the properties below are optional
  description: 'description',
  gatewayTargetName: 'gatewayTargetName',
};

Properties ​

credentialProviderConfigurationsICredentialProviderConfig[]credential_provider_configurationstyping.List[ICredentialProviderConfig]credentialProviderConfigurationsList<ICredentialProviderConfig>CredentialProviderConfigurationsICredentialProviderConfig[]CredentialProviderConfigurations*[]ICredentialProviderConfigrequired#
Credential providers for authentication.

MCP servers require explicit authentication configuration. OAuth2 is strongly recommended over NoAuth.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Optional description for the gateway target.

Default: No description

endpointstringendpointstrendpointStringEndpointstringEndpoint*stringrequired#
The HTTPS endpoint URL of the MCP server.

The endpoint must:

  • Use HTTPS protocol
  • Be properly URL-encoded
  • Point to an MCP server that implements tool capabilities
gatewayTargetNameoptionalstringgateway_target_nameoptionalstrgatewayTargetNameoptionalStringGatewayTargetNameoptionalstringGatewayTargetNameoptional*string#
The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).

Default: auto generate