software.amazon.awscdk.services.apigatewayv2

Interface HttpApiMappingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpApiMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.499Z")
 @Stability(value=Experimental)
public interface HttpApiMappingProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties used to create the HttpApiMapping resource.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HttpApiMappingProps.Builder A builder for HttpApiMappingProps
static class	HttpApiMappingProps.Jsii$Proxy An implementation for HttpApiMappingProps

Method Summary

Modifier and Type	Method and Description
static HttpApiMappingProps.Builder	builder()
IHttpApi	getApi() (experimental) The HttpApi to which this mapping is applied.
default String	getApiMappingKey() (experimental) Api mapping key.
IDomainName	getDomainName() (experimental) custom domain name of the mapping target.
default IHttpStage	getStage() (experimental) stage for the HttpApiMapping resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApi

@Stability(value=Experimental)
 @NotNull
IHttpApi getApi()

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

getDomainName

@Stability(value=Experimental)
 @NotNull
IDomainName getDomainName()

(experimental) custom domain name of the mapping target.

getApiMappingKey

@Stability(value=Experimental)
 @Nullable
default String getApiMappingKey()

(experimental) Api mapping key.

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

Default: - undefined for the root path mapping.

getStage

@Stability(value=Experimental)
 @Nullable
default IHttpStage getStage()

(experimental) stage for the HttpApiMapping resource.

Default: - the $default stage

builder

@Stability(value=Experimental)
static HttpApiMappingProps.Builder builder()

Returns:

a HttpApiMappingProps.Builder of HttpApiMappingProps