Package software.amazon.awscdk.services.bedrockagentcore

Class GatewayTargetOpenApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.GatewayTargetOpenApiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GatewayTargetOpenApiProps>

Enclosing interface:

GatewayTargetOpenApiProps

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

A builder for GatewayTargetOpenApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GatewayTargetOpenApiProps.Builder	apiSchema(ApiSchema apiSchema)	Sets the value of GatewayTargetOpenApiProps.getApiSchema()
GatewayTargetOpenApiProps	build()	Builds the configured instance.
GatewayTargetOpenApiProps.Builder	credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)	Sets the value of GatewayTargetOpenApiProps.getCredentialProviderConfigurations()
GatewayTargetOpenApiProps.Builder	description(String description)	Sets the value of GatewayTargetCommonProps.getDescription()
GatewayTargetOpenApiProps.Builder	gateway(IGateway gateway)	Sets the value of GatewayTargetOpenApiProps.getGateway()
GatewayTargetOpenApiProps.Builder	gatewayTargetName(String gatewayTargetName)	Sets the value of GatewayTargetCommonProps.getGatewayTargetName()
GatewayTargetOpenApiProps.Builder	validateOpenApiSchema(Boolean validateOpenApiSchema)	Sets the value of GatewayTargetOpenApiProps.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 GatewayTargetOpenApiProps.Builder apiSchema(ApiSchema apiSchema)

Sets the value of GatewayTargetOpenApiProps.getApiSchema()

Parameters:

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

Returns:

this

gateway

@Stability(Stable)
public GatewayTargetOpenApiProps.Builder gateway(IGateway gateway)

Sets the value of GatewayTargetOpenApiProps.getGateway()

Parameters:

gateway - The gateway this target belongs to. This parameter is required.

Returns:

this

credentialProviderConfigurations

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

Sets the value of GatewayTargetOpenApiProps.getCredentialProviderConfigurations()

Parameters:

credentialProviderConfigurations - Credential providers for authentication OpenAPI targets support API key and OAuth authentication (not IAM).

Returns:

this

validateOpenApiSchema

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

Sets the value of GatewayTargetOpenApiProps.getValidateOpenApiSchema()

Parameters:

validateOpenApiSchema - Whether to validate the OpenAPI schema (only applies to inline schemas) Note: Validation is only performed for inline schemas during CDK synthesis. S3 and asset-based schemas cannot be validated at synthesis time.

Returns:

this

description

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

Sets the value of GatewayTargetCommonProps.getDescription()

Parameters:

description - Optional description for the gateway target The description can have up to 200 characters.

Returns:

this

gatewayTargetName

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

Sets the value of GatewayTargetCommonProps.getGatewayTargetName()

Parameters:

gatewayTargetName - The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

Returns:

this

build

@Stability(Stable)
public GatewayTargetOpenApiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GatewayTargetOpenApiProps

Throws:

NullPointerException - if any required attribute was not provided