software.amazon.awscdk.services.apigatewayv2

Class HttpApiMapping.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpApiMapping.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpApiMapping>

Enclosing class:

HttpApiMapping

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

(experimental) A fluent builder for HttpApiMapping.

Method Summary

Modifier and Type	Method and Description
HttpApiMapping.Builder	api(IHttpApi api) (experimental) The HttpApi to which this mapping is applied.
HttpApiMapping.Builder	apiMappingKey(String apiMappingKey) (experimental) Api mapping key.
HttpApiMapping	build()
static HttpApiMapping.Builder	create(software.constructs.Construct scope, String id)
HttpApiMapping.Builder	domainName(IDomainName domainName) (experimental) custom domain name of the mapping target.
HttpApiMapping.Builder	stage(IHttpStage stage) (experimental) stage for the HttpApiMapping resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static HttpApiMapping.Builder create(software.constructs.Construct scope,
                                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of HttpApiMapping.Builder.

api

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

(experimental) The HttpApi to which this mapping is applied.

Parameters:

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

Returns:

this

domainName

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

(experimental) custom domain name of the mapping target.

Parameters:

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

Returns:

this

apiMappingKey

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

(experimental) 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(value=Experimental)
public HttpApiMapping.Builder stage(IHttpStage stage)

(experimental) stage for the HttpApiMapping resource.

Default: - the $default stage

Parameters:

stage - stage for the HttpApiMapping resource. This parameter is required.

Returns:

this

build

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

Specified by:

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