Package software.amazon.awscdk.services.apigatewayv2

Interface CfnApi.CorsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.CorsProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.CorsProperty
extends software.amazon.jsii.JsiiSerializable

The Cors property specifies a CORS configuration for an API.

Supported only for HTTP APIs. See Configuring CORS for more information.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 CorsProperty corsProperty = CorsProperty.builder()
         .allowCredentials(false)
         .allowHeaders(List.of("allowHeaders"))
         .allowMethods(List.of("allowMethods"))
         .allowOrigins(List.of("allowOrigins"))
         .exposeHeaders(List.of("exposeHeaders"))
         .maxAge(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowCredentials

@Stability(Stable)
@Nullable
default Object getAllowCredentials()

Specifies whether credentials are included in the CORS request.

Supported only for HTTP APIs.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowcredentials

getAllowHeaders

@Stability(Stable)
@Nullable
default List<String> getAllowHeaders()

Represents a collection of allowed headers.

Supported only for HTTP APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowheaders

getAllowMethods

@Stability(Stable)
@Nullable
default List<String> getAllowMethods()

Represents a collection of allowed HTTP methods.

Supported only for HTTP APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowmethods

getAllowOrigins

@Stability(Stable)
@Nullable
default List<String> getAllowOrigins()

Represents a collection of allowed origins.

Supported only for HTTP APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-alloworigins

getExposeHeaders

@Stability(Stable)
@Nullable
default List<String> getExposeHeaders()

Represents a collection of exposed headers.

Supported only for HTTP APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-exposeheaders

getMaxAge

@Stability(Stable)
@Nullable
default Number getMaxAge()

The number of seconds that the browser should cache preflight request results.

Supported only for HTTP APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-maxage

builder

@Stability(Stable)
static CfnApi.CorsProperty.Builder builder()

Returns:

a CfnApi.CorsProperty.Builder of CfnApi.CorsProperty