> **Experimental**
>
> `@aws-cdk/aws-bedrock-agentcore-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# AddOpenApiTargetOptions

Options for adding an OpenAPI target to a gateway.

- Source: [`lib/gateway/gateway.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0-alpha.0/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/gateway.ts#L128)

## 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 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

- `apiSchema`: [ApiSchema](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.ApiSchema.html) (required) — The OpenAPI schema defining the API.

- `credentialProviderConfigurations`: [ICredentialProviderConfig](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.ICredentialProviderConfig.html)[] — Credential providers for outbound authentication (OpenAPI targets use API Key or OAuth, not IAM).

  **Default:** none (no credential configuration on the target; supply providers for secured backends)

- `description`: string — Optional description for the gateway target.

  **Default:** No description

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

  **Default:** auto generate

- `validateOpenApiSchema`: boolean = 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.
