Package software.amazon.awscdk.services.bedrockagentcore

Class AddOpenApiTargetOptions.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.AddOpenApiTargetOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AddOpenApiTargetOptions>

Enclosing interface:

AddOpenApiTargetOptions

@Stability(Stable)
public static final class AddOpenApiTargetOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AddOpenApiTargetOptions>

A builder for AddOpenApiTargetOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AddOpenApiTargetOptions.Builder	apiSchema(ApiSchema apiSchema)	Sets the value of AddOpenApiTargetOptions.getApiSchema()
AddOpenApiTargetOptions	build()	Builds the configured instance.
AddOpenApiTargetOptions.Builder	credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)	Sets the value of AddOpenApiTargetOptions.getCredentialProviderConfigurations()
AddOpenApiTargetOptions.Builder	description(String description)	Sets the value of AddOpenApiTargetOptions.getDescription()
AddOpenApiTargetOptions.Builder	gatewayTargetName(String gatewayTargetName)	Sets the value of AddOpenApiTargetOptions.getGatewayTargetName()
AddOpenApiTargetOptions.Builder	validateOpenApiSchema(Boolean validateOpenApiSchema)	Sets the value of AddOpenApiTargetOptions.getValidateOpenApiSchema()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

apiSchema

@Stability(Stable)
public AddOpenApiTargetOptions.Builder apiSchema(ApiSchema apiSchema)

Sets the value of AddOpenApiTargetOptions.getApiSchema()

Parameters:

apiSchema - The OpenAPI schema defining the API. This parameter is required.

Returns:

this

credentialProviderConfigurations

@Stability(Stable)
public AddOpenApiTargetOptions.Builder credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)

Sets the value of AddOpenApiTargetOptions.getCredentialProviderConfigurations()

Parameters:

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

Returns:

this

description

@Stability(Stable)
public AddOpenApiTargetOptions.Builder description(String description)

Sets the value of AddOpenApiTargetOptions.getDescription()

Parameters:

description - Optional description for the gateway target.

Returns:

this

gatewayTargetName

@Stability(Stable)
public AddOpenApiTargetOptions.Builder gatewayTargetName(String gatewayTargetName)

Sets the value of AddOpenApiTargetOptions.getGatewayTargetName()

Parameters:

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

Returns:

this

validateOpenApiSchema

@Stability(Stable)
public AddOpenApiTargetOptions.Builder validateOpenApiSchema(Boolean validateOpenApiSchema)

Sets the value of AddOpenApiTargetOptions.getValidateOpenApiSchema()

Parameters:

validateOpenApiSchema - 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.

Returns:

this

build

@Stability(Stable)
public AddOpenApiTargetOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AddOpenApiTargetOptions>

Returns:

a new instance of AddOpenApiTargetOptions

Throws:

NullPointerException - if any required attribute was not provided