Package software.amazon.awscdk.services.apigatewayv2

Class ApiMappingProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.ApiMappingProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiMappingProps>

Enclosing interface:

ApiMappingProps

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

A builder for ApiMappingProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiMappingProps.Builder	api(IApi api)	Sets the value of ApiMappingProps.getApi()
ApiMappingProps.Builder	apiMappingKey(String apiMappingKey)	Sets the value of ApiMappingProps.getApiMappingKey()
ApiMappingProps	build()	Builds the configured instance.
ApiMappingProps.Builder	domainName(IDomainName domainName)	Sets the value of ApiMappingProps.getDomainName()
ApiMappingProps.Builder	stage(IStage stage)	Sets the value of ApiMappingProps.getStage()

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

api

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

Sets the value of ApiMappingProps.getApi()

Parameters:

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

Returns:

this

domainName

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

Sets the value of ApiMappingProps.getDomainName()

Parameters:

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

Returns:

this

apiMappingKey

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

Sets the value of ApiMappingProps.getApiMappingKey()

Parameters:

apiMappingKey - Api mapping key. The path where this stage should be mapped to on the domain

Returns:

this

stage

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

Sets the value of ApiMappingProps.getStage()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public ApiMappingProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiMappingProps

Throws:

NullPointerException - if any required attribute was not provided