@aws-cdk/aws-bedrock-agentcore-alpha.AddApiGatewayTargetOptions

Experimental

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

AddApiGatewayTargetOptions Struct

Options for adding an API Gateway target to a gateway.

Source

lib/gateway/gateway.ts

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';
import { aws_apigateway as apigateway } from 'aws-cdk-lib';

declare const credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
declare const restApi: apigateway.RestApi;
const addApiGatewayTargetOptions: bedrock_agentcore_alpha.AddApiGatewayTargetOptions = {
  apiGatewayToolConfiguration: {
    toolFilters: [{
      filterPath: 'filterPath',
      methods: [bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET],
    }],

    // the properties below are optional
    toolOverrides: [{
      method: bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET,
      name: 'name',
      path: 'path',

      // the properties below are optional
      description: 'description',
    }],
  },
  restApi: restApi,

  // the properties below are optional
  credentialProviderConfigurations: [credentialProviderConfig],
  description: 'description',
  gatewayTargetName: 'gatewayTargetName',
  metadataConfiguration: {
    allowedQueryParameters: ['allowedQueryParameters'],
    allowedRequestHeaders: ['allowedRequestHeaders'],
    allowedResponseHeaders: ['allowedResponseHeaders'],
  },
  stage: 'stage',
};

Properties

apiGatewayToolConfigurationApiGatewayToolConfigurationapi_gateway_tool_configurationApiGatewayToolConfigurationapiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationApiGatewayToolConfigurationrequired#

Tool configuration defining which operations to expose.

credentialProviderConfigurationsICredentialProviderConfig[]credential_provider_configurationstyping.List[ICredentialProviderConfig]credentialProviderConfigurationsList<ICredentialProviderConfig>CredentialProviderConfigurationsICredentialProviderConfig[]CredentialProviderConfigurations*[]ICredentialProviderConfig#

Credential providers for authentication API Gateway targets support IAM and API key authentication.

Default: Empty array (service handles IAM automatically)

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

Optional description for the gateway target.

Default: No description

gatewayTargetNamestringgateway_target_namestrgatewayTargetNameStringGatewayTargetNamestringGatewayTargetName*string#

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

Default: auto generate

metadataConfigurationMetadataConfigurationmetadata_configurationMetadataConfigurationmetadataConfigurationMetadataConfigurationMetadataConfigurationMetadataConfigurationMetadataConfigurationMetadataConfiguration#

Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.

Default: No metadata configuration

restApiIRestApirest_apiIRestApirestApiIRestApiRestApiIRestApiRestApiIRestApirequired#

The REST API to integrate with Must be in the same account and region as the gateway [disable-awslint:prefer-ref-interface].

stagestringstagestrstageStringStagestringStage*string#

The stage name of the REST API.

Default: Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)