interface CfnGatewayTargetProps

Language	Type name
.NET	`Amazon.CDK.AWS.BedrockAgentCore.CfnGatewayTargetProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnGatewayTargetProps`
Java	`software.amazon.awscdk.services.bedrockagentcore.CfnGatewayTargetProps`
Python	`aws_cdk.aws_bedrockagentcore.CfnGatewayTargetProps`
TypeScript	`aws-cdk-lib` » `aws_bedrockagentcore` » `CfnGatewayTargetProps`

Properties for defining a CfnGatewayTarget.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';

declare const schemaDefinitionProperty_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty;
const cfnGatewayTargetProps: bedrockagentcore.CfnGatewayTargetProps = {
  name: 'name',
  targetConfiguration: {
    mcp: {
      apiGateway: {
        apiGatewayToolConfiguration: {
          toolFilters: [{
            filterPath: 'filterPath',
            methods: ['methods'],
          }],

          // the properties below are optional
          toolOverrides: [{
            method: 'method',
            name: 'name',
            path: 'path',

            // the properties below are optional
            description: 'description',
          }],
        },
        restApiId: 'restApiId',
        stage: 'stage',
      },
      lambda: {
        lambdaArn: 'lambdaArn',
        toolSchema: {
          inlinePayload: [{
            description: 'description',
            inputSchema: {
              type: 'type',

              // the properties below are optional
              description: 'description',
              items: schemaDefinitionProperty_,
              properties: {
                propertiesKey: schemaDefinitionProperty_,
              },
              required: ['required'],
            },
            name: 'name',

            // the properties below are optional
            outputSchema: {
              type: 'type',

              // the properties below are optional
              description: 'description',
              items: schemaDefinitionProperty_,
              properties: {
                propertiesKey: schemaDefinitionProperty_,
              },
              required: ['required'],
            },
          }],
          s3: {
            bucketOwnerAccountId: 'bucketOwnerAccountId',
            uri: 'uri',
          },
        },
      },
      mcpServer: {
        endpoint: 'endpoint',
      },
      openApiSchema: {
        inlinePayload: 'inlinePayload',
        s3: {
          bucketOwnerAccountId: 'bucketOwnerAccountId',
          uri: 'uri',
        },
      },
      smithyModel: {
        inlinePayload: 'inlinePayload',
        s3: {
          bucketOwnerAccountId: 'bucketOwnerAccountId',
          uri: 'uri',
        },
      },
    },
  },

  // the properties below are optional
  credentialProviderConfigurations: [{
    credentialProviderType: 'credentialProviderType',

    // the properties below are optional
    credentialProvider: {
      apiKeyCredentialProvider: {
        providerArn: 'providerArn',

        // the properties below are optional
        credentialLocation: 'credentialLocation',
        credentialParameterName: 'credentialParameterName',
        credentialPrefix: 'credentialPrefix',
      },
      oauthCredentialProvider: {
        providerArn: 'providerArn',
        scopes: ['scopes'],

        // the properties below are optional
        customParameters: {
          customParametersKey: 'customParameters',
        },
        defaultReturnUrl: 'defaultReturnUrl',
        grantType: 'grantType',
      },
    },
  }],
  description: 'description',
  gatewayIdentifier: 'gatewayIdentifier',
  metadataConfiguration: {
    allowedQueryParameters: ['allowedQueryParameters'],
    allowedRequestHeaders: ['allowedRequestHeaders'],
    allowedResponseHeaders: ['allowedResponseHeaders'],
  },
};

Properties

Name	Type	Description
name	`string`	The name for the gateway target.
targetConfiguration	`IResolvable` `\|` `TargetConfigurationProperty`	The target configuration for the Smithy model target.
credentialProviderConfigurations?	`IResolvable` `\| (IResolvable` `\|` `CredentialProviderConfigurationProperty)[]`	The OAuth credential provider configuration.
description?	`string`	The description for the gateway target.
gatewayIdentifier?	`string`	The gateway ID for the gateway target.
metadataConfiguration?	`IResolvable` `\|` `MetadataConfigurationProperty`

name

Type: string

The name for the gateway target.

targetConfiguration

Type: IResolvable | TargetConfigurationProperty

The target configuration for the Smithy model target.

credentialProviderConfigurations?

Type: IResolvable | (IResolvable | CredentialProviderConfigurationProperty)[] (optional)

The OAuth credential provider configuration.

description?

Type: string (optional)

The description for the gateway target.

gatewayIdentifier?

Type: string (optional)

The gateway ID for the gateway target.

metadataConfiguration?

Type: IResolvable | MetadataConfigurationProperty (optional)

AWS CDK

2.237.1