Package software.amazon.awscdk.services.bedrock.agentcore.alpha

Interface AddOpenApiTargetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddOpenApiTargetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:40.275Z")
@Stability(Deprecated)
@Deprecated
public interface AddOpenApiTargetOptions
extends software.amazon.jsii.JsiiSerializable

Deprecated.

Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

(deprecated) 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 software.amazon.awscdk.services.bedrock.agentcore.alpha.*;
 ApiSchema apiSchema;
 ICredentialProviderConfig credentialProviderConfig;
 AddOpenApiTargetOptions addOpenApiTargetOptions = AddOpenApiTargetOptions.builder()
         .apiSchema(apiSchema)
         // the properties below are optional
         .credentialProviderConfigurations(List.of(credentialProviderConfig))
         .description("description")
         .gatewayTargetName("gatewayTargetName")
         .validateOpenApiSchema(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AddOpenApiTargetOptions.Builder	Deprecated.
static final class	AddOpenApiTargetOptions.Jsii$Proxy	Deprecated.

Method Summary

Modifier and Type	Method	Description
static AddOpenApiTargetOptions.Builder	builder()	Deprecated.
ApiSchema	getApiSchema()	Deprecated.
default List<ICredentialProviderConfig>	getCredentialProviderConfigurations()	Deprecated.
default String	getDescription()	Deprecated.
default String	getGatewayTargetName()	Deprecated.
default Boolean	getValidateOpenApiSchema()	Deprecated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiSchema

@Stability(Deprecated)
@Deprecated
@NotNull
ApiSchema getApiSchema()

Deprecated.

(deprecated) The OpenAPI schema defining the API.

getCredentialProviderConfigurations

@Stability(Deprecated)
@Deprecated
@Nullable
default List<ICredentialProviderConfig> getCredentialProviderConfigurations()

Deprecated.

(deprecated) 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)

getDescription

@Stability(Deprecated)
@Deprecated
@Nullable
default String getDescription()

Deprecated.

(deprecated) Optional description for the gateway target.

Default: - No description

getGatewayTargetName

@Stability(Deprecated)
@Deprecated
@Nullable
default String getGatewayTargetName()

Deprecated.

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

Default: - auto generate

getValidateOpenApiSchema

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getValidateOpenApiSchema()

Deprecated.

(deprecated) 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.

Default: true

builder

@Stability(Deprecated)
@Deprecated
static AddOpenApiTargetOptions.Builder builder()

Deprecated.

Returns:

a AddOpenApiTargetOptions.Builder of AddOpenApiTargetOptions