Package software.amazon.awscdk.services.apigatewayv2

Class ApiMapping.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.ApiMapping.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiMapping>

Enclosing class:

ApiMapping

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

A fluent builder for ApiMapping.

Method Summary

Modifier and Type	Method	Description
ApiMapping.Builder	api(IApi api)	The Api to which this mapping is applied.
ApiMapping.Builder	apiMappingKey(String apiMappingKey)	Api mapping key.
ApiMapping	build()
static ApiMapping.Builder	create(software.constructs.Construct scope, String id)
ApiMapping.Builder	domainName(IDomainName domainName)	custom domain name of the mapping target.
ApiMapping.Builder	stage(IStage stage)	stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static ApiMapping.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ApiMapping.Builder.

api

@Stability(Stable)
public ApiMapping.Builder api(IApi api)

The Api to which this mapping is applied.

Parameters:

api - The Api to which this mapping is applied. This parameter is required.

Returns:

this

domainName

@Stability(Stable)
public ApiMapping.Builder domainName(IDomainName domainName)

custom domain name of the mapping target.

Parameters:

domainName - custom domain name of the mapping target. This parameter is required.

Returns:

this

apiMappingKey

@Stability(Stable)
public ApiMapping.Builder apiMappingKey(String apiMappingKey)

Api mapping key.

The path where this stage should be mapped to on the domain

Default: - undefined for the root path mapping.

Parameters:

apiMappingKey - Api mapping key. This parameter is required.

Returns:

this

stage

@Stability(Stable)
public ApiMapping.Builder stage(IStage stage)

stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

Default: - Default stage of the passed API for HTTP API, required for WebSocket API

Parameters:

stage - stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API. This parameter is required.

Returns:

this

build

@Stability(Stable)
public ApiMapping build()

Specified by:

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

Returns:

a newly built instance of ApiMapping.