software.amazon.awscdk.services.apigatewayv2

Class HttpApiMappingProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpApiMappingProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpApiMappingProps>

Enclosing interface:

HttpApiMappingProps

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

A builder for HttpApiMappingProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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

api

@Stability(value=Experimental)
public HttpApiMappingProps.Builder api(IHttpApi api)

Sets the value of HttpApiMappingProps.getApi()

Parameters:

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

Returns:

this

domainName

@Stability(value=Experimental)
public HttpApiMappingProps.Builder domainName(IDomainName domainName)

Sets the value of HttpApiMappingProps.getDomainName()

Parameters:

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

Returns:

this

apiMappingKey

@Stability(value=Experimental)
public HttpApiMappingProps.Builder apiMappingKey(String apiMappingKey)

Sets the value of HttpApiMappingProps.getApiMappingKey()

Parameters:

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

Returns:

this

stage

@Stability(value=Experimental)
public HttpApiMappingProps.Builder stage(IHttpStage stage)

Sets the value of HttpApiMappingProps.getStage()

Parameters:

stage - stage for the HttpApiMapping resource.

Returns:

this

build

@Stability(value=Experimental)
public HttpApiMappingProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HttpApiMappingProps

Throws:

NullPointerException - if any required attribute was not provided