Package software.amazon.awscdk.services.lambda

Interface CfnUrl.CorsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUrl.CorsProperty.Jsii$Proxy

Enclosing class:

CfnUrl

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

The Cross-Origin Resource Sharing (CORS) settings for your function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.

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.lambda.*;
 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUrl.CorsProperty.Builder	builder()
default Object	getAllowCredentials()	Whether you want to allow cookies or other credentials in requests to your function URL.
default List<String>	getAllowHeaders()	The HTTP headers that origins can include in requests to your function URL.
default List<String>	getAllowMethods()	The HTTP methods that are allowed when calling your function URL.
default List<String>	getAllowOrigins()	The origins that can access your function URL.
default List<String>	getExposeHeaders()	The HTTP headers in your function response that you want to expose to origins that call your function URL.
default Number	getMaxAge()	The maximum amount of time, in seconds, that browsers can cache results of a preflight request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowCredentials

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

Whether you want to allow cookies or other credentials in requests to your function URL.

The default is false .

getAllowHeaders

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

The HTTP headers that origins can include in requests to your function URL.

For example: Date , Keep-Alive , X-Custom-Header .

getAllowMethods

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

The HTTP methods that are allowed when calling your function URL.

For example: GET , POST , DELETE , or the wildcard character ( * ).

getAllowOrigins

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

The origins that can access your function URL.

You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .

Alternatively, you can grant access to all origins with the wildcard character ( * ).

getExposeHeaders

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

The HTTP headers in your function response that you want to expose to origins that call your function URL.

For example: Date , Keep-Alive , X-Custom-Header .

getMaxAge

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

The maximum amount of time, in seconds, that browsers can cache results of a preflight request.

By default, this is set to 0 , which means the browser will not cache results.

builder

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

Returns:

a CfnUrl.CorsProperty.Builder of CfnUrl.CorsProperty