com.github.mmuller88.cdkAlpsSpecRestApi

Class AlpsSpecRestApi.Builder

java.lang.Object

com.github.mmuller88.cdkAlpsSpecRestApi.AlpsSpecRestApi.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AlpsSpecRestApi>

Enclosing class:

AlpsSpecRestApi

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

A fluent builder for AlpsSpecRestApi.

Method Summary

Modifier and Type	Method and Description
AlpsSpecRestApi.Builder	alpsSpecFile(String alpsSpecFile) ALPS Spec File.
AlpsSpecRestApi	build()
static AlpsSpecRestApi.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
AlpsSpecRestApi.Builder	operationIdLambdaMapping(Map<String,String> operationIdLambdaMapping) Optional mapping from openApi spec operationId to Lambda name.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static AlpsSpecRestApi.Builder create(software.amazon.awscdk.core.Construct scope,
                                                                      String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AlpsSpecRestApi.Builder.

alpsSpecFile

@Stability(value=Stable)
public AlpsSpecRestApi.Builder alpsSpecFile(String alpsSpecFile)

ALPS Spec File.

Must be YAML.

Parameters:

alpsSpecFile - ALPS Spec File. This parameter is required.

Returns:

this

operationIdLambdaMapping

@Stability(value=Stable)
public AlpsSpecRestApi.Builder operationIdLambdaMapping(Map<String,String> operationIdLambdaMapping)

Optional mapping from openApi spec operationId to Lambda name.

Per default it uses a Lambda integration with using the openApi spec operationId property as Lambda name

Parameters:

operationIdLambdaMapping - Optional mapping from openApi spec operationId to Lambda name. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public AlpsSpecRestApi build()

Specified by:

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