Package software.aws.awsprototypingsdk.openapigateway

Class OpenApiOptions.Builder

java.lang.Object

software.aws.awsprototypingsdk.openapigateway.OpenApiOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OpenApiOptions>

Enclosing interface:

OpenApiOptions

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

A builder for OpenApiOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenApiOptions	build()	Builds the configured instance.
OpenApiOptions.Builder	corsOptions(software.amazon.awscdk.services.apigateway.CorsOptions corsOptions)	Sets the value of OpenApiOptions.getCorsOptions()
OpenApiOptions.Builder	defaultAuthorizer(Authorizer defaultAuthorizer)	Sets the value of OpenApiOptions.getDefaultAuthorizer()
OpenApiOptions.Builder	integrations(Map<String,? extends OpenApiIntegration> integrations)	Sets the value of OpenApiOptions.getIntegrations()
OpenApiOptions.Builder	operationLookup(Map<String,? extends MethodAndPath> operationLookup)	Sets the value of OpenApiOptions.getOperationLookup()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

integrations

@Stability(Experimental)
public OpenApiOptions.Builder integrations(Map<String,? extends OpenApiIntegration> integrations)

Sets the value of OpenApiOptions.getIntegrations()

Parameters:

integrations - A mapping of API operation to its integration. This parameter is required.

Returns:

this

operationLookup

@Stability(Experimental)
public OpenApiOptions.Builder operationLookup(Map<String,? extends MethodAndPath> operationLookup)

Sets the value of OpenApiOptions.getOperationLookup()

Parameters:

operationLookup - Details about each operation. This parameter is required.

Returns:

this

corsOptions

@Stability(Experimental)
public OpenApiOptions.Builder corsOptions(software.amazon.awscdk.services.apigateway.CorsOptions corsOptions)

Sets the value of OpenApiOptions.getCorsOptions()

Parameters:

corsOptions - Cross Origin Resource Sharing options for the API.

Returns:

this

defaultAuthorizer

@Stability(Experimental)
public OpenApiOptions.Builder defaultAuthorizer(Authorizer defaultAuthorizer)

Sets the value of OpenApiOptions.getDefaultAuthorizer()

Parameters:

defaultAuthorizer - The default authorizer to use for your api. When omitted, no authorizer is used. Authorizers specified at the integration level will override this for that operation.

Returns:

this

build

@Stability(Experimental)
public OpenApiOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of OpenApiOptions

Throws:

NullPointerException - if any required attribute was not provided