2.256.0

interface AddOpenApiTargetOptions 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Agentcore.Alpha.AddOpenApiTargetOptions
Gogithub.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#AddOpenApiTargetOptions
Javasoftware.amazon.awscdk.services.bedrock.agentcore.alpha.AddOpenApiTargetOptions
Pythonaws_cdk.aws_bedrock_agentcore_alpha.AddOpenApiTargetOptions
TypeScript (source)@aws-cdk/aws-bedrock-agentcore-alpha » AddOpenApiTargetOptions

Options for adding an OpenAPI target to a gateway.

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;
const addOpenApiTargetOptions: bedrock_agentcore_alpha.AddOpenApiTargetOptions = {
  apiSchema: apiSchema,

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

Properties

NameTypeDescription
apiSchema🔹ApiSchemaThe OpenAPI schema defining the API.
credentialProviderConfigurations?🔹ICredentialProviderConfig[]Credential providers for outbound authentication (OpenAPI targets use API Key or OAuth, not IAM).
description?🔹stringOptional description for the gateway target.
gatewayTargetName?🔹stringThe name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).
validateOpenApiSchema?🔹booleanWhether to validate the OpenAPI schema or not Note: Validation is only performed for inline and asset-based schema and during CDK synthesis.

apiSchema🔹

Type: ApiSchema

The OpenAPI schema defining the API.

credentialProviderConfigurations?🔹

Type: ICredentialProviderConfig[] (optional, default: none (no credential configuration on the target; supply providers for secured backends))

Credential providers for outbound authentication (OpenAPI targets use API Key or OAuth, not IAM).

description?🔹

Type: string (optional, default: No description)

Optional description for the gateway target.

gatewayTargetName?🔹

Type: string (optional, default: auto generate)

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

validateOpenApiSchema?🔹

Type: boolean (optional, default: true)

Whether to validate the OpenAPI schema or not Note: Validation is only performed for inline and asset-based schema and during CDK synthesis.

S3 schemas cannot be validated at synthesis time.

← PreviousNext →