software.amazon.awscdk.services.apigatewayv2

Interface CorsPreflightOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CorsPreflightOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.987Z")
 @Stability(value=Experimental)
public interface CorsPreflightOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for the CORS Configuration.

Example:

 HttpApi.Builder.create(this, "HttpProxyApi")
         .corsPreflight(CorsPreflightOptions.builder()
                 .allowHeaders(List.of("Authorization"))
                 .allowMethods(List.of(CorsHttpMethod.GET, CorsHttpMethod.HEAD, CorsHttpMethod.OPTIONS, CorsHttpMethod.POST))
                 .allowOrigins(List.of("*"))
                 .maxAge(Duration.days(10))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CorsPreflightOptions.Builder	builder()
default Boolean	getAllowCredentials() (experimental) Specifies whether credentials are included in the CORS request.
default List<String>	getAllowHeaders() (experimental) Represents a collection of allowed headers.
default List<CorsHttpMethod>	getAllowMethods() (experimental) Represents a collection of allowed HTTP methods.
default List<String>	getAllowOrigins() (experimental) Represents a collection of allowed origins.
default List<String>	getExposeHeaders() (experimental) Represents a collection of exposed headers.
default Duration	getMaxAge() (experimental) The duration that the browser should cache preflight request results.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllowCredentials

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

(experimental) Specifies whether credentials are included in the CORS request.

Default: false

getAllowHeaders

@Stability(value=Experimental)
 @Nullable
default List<String> getAllowHeaders()

(experimental) Represents a collection of allowed headers.

Default: - No Headers are allowed.

getAllowMethods

@Stability(value=Experimental)
 @Nullable
default List<CorsHttpMethod> getAllowMethods()

(experimental) Represents a collection of allowed HTTP methods.

Default: - No Methods are allowed.

getAllowOrigins

@Stability(value=Experimental)
 @Nullable
default List<String> getAllowOrigins()

(experimental) Represents a collection of allowed origins.

Default: - No Origins are allowed.

getExposeHeaders

@Stability(value=Experimental)
 @Nullable
default List<String> getExposeHeaders()

(experimental) Represents a collection of exposed headers.

Default: - No Expose Headers are allowed.

getMaxAge

@Stability(value=Experimental)
 @Nullable
default Duration getMaxAge()

(experimental) The duration that the browser should cache preflight request results.

Default: Duration.seconds(0)

builder

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

Returns:

a CorsPreflightOptions.Builder of CorsPreflightOptions