software.amazon.awscdk.services.apigatewayv2

Interface HttpApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpApiProps.Jsii$Proxy

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

(experimental) Properties to initialize an instance of `HttpApi`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static HttpApiProps.Builder	builder()
default String	getApiName() (experimental) Name for the HTTP API resoruce.
default CorsPreflightOptions	getCorsPreflight() (experimental) Specifies a CORS configuration for an API.
default Boolean	getCreateDefaultStage() (experimental) Whether a default stage and deployment should be automatically created.
default DefaultDomainMappingOptions	getDefaultDomainMapping() (experimental) Configure a custom domain with the API mapping resource to the HTTP API.
default IHttpRouteIntegration	getDefaultIntegration() (experimental) An integration that will be configured on the catch-all route ($default).
default String	getDescription() (experimental) The description of the API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiName

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

(experimental) Name for the HTTP API resoruce.

Default: - id of the HttpApi construct.

getCorsPreflight

@Stability(value=Experimental)
 @Nullable
default CorsPreflightOptions getCorsPreflight()

(experimental) Specifies a CORS configuration for an API.

Default: - CORS disabled.

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html

getCreateDefaultStage

@Stability(value=Experimental)
 @Nullable
default Boolean getCreateDefaultStage()

(experimental) Whether a default stage and deployment should be automatically created.

Default: true

getDefaultDomainMapping

@Stability(value=Experimental)
 @Nullable
default DefaultDomainMappingOptions getDefaultDomainMapping()

(experimental) Configure a custom domain with the API mapping resource to the HTTP API.

Default: - no default domain mapping configured. meaningless if `createDefaultStage` is `false`.

getDefaultIntegration

@Stability(value=Experimental)
 @Nullable
default IHttpRouteIntegration getDefaultIntegration()

(experimental) An integration that will be configured on the catch-all route ($default).

Default: - none

getDescription

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

(experimental) The description of the API.

Default: - none

builder

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

Returns:

a HttpApiProps.Builder of HttpApiProps