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 -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofGatewayTargetOpenApiProps.getApiSchema()build()Builds the configured instance.credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations) Sets the value ofGatewayTargetOpenApiProps.getCredentialProviderConfigurations()description(String description) Sets the value ofGatewayTargetCommonProps.getDescription()Sets the value ofGatewayTargetOpenApiProps.getGateway()gatewayTargetName(String gatewayTargetName) Sets the value ofGatewayTargetCommonProps.getGatewayTargetName()validateOpenApiSchema(Boolean validateOpenApiSchema) Sets the value ofGatewayTargetOpenApiProps.getValidateOpenApiSchema()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiSchema
Sets the value ofGatewayTargetOpenApiProps.getApiSchema()- Parameters:
apiSchema- The OpenAPI schema defining the API. This parameter is required.- Returns:
this
-
gateway
Sets the value ofGatewayTargetOpenApiProps.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 ofGatewayTargetOpenApiProps.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 ofGatewayTargetOpenApiProps.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
Sets the value ofGatewayTargetCommonProps.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 ofGatewayTargetCommonProps.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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<GatewayTargetOpenApiProps>- Returns:
- a new instance of
GatewayTargetOpenApiProps - Throws:
NullPointerException- if any required attribute was not provided
-