software.amazon.awscdk.services.lambda

Interface CfnUrl.CorsProperty

All Known Implementing Classes:

CfnUrl.CorsProperty.Jsii$Proxy

Enclosing class:

CfnUrl

public static interface CfnUrl.CorsProperty

The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/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 and Description
static class	CfnUrl.CorsProperty.Builder A builder for CfnUrl.CorsProperty
static class	CfnUrl.CorsProperty.Jsii$Proxy An implementation for CfnUrl.CorsProperty

Method Summary

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

Method Detail

getAllowCredentials

default java.lang.Object getAllowCredentials()

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

The default is false .

getAllowHeaders

default java.util.List<java.lang.String> getAllowHeaders()

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

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

getAllowMethods

default java.util.List<java.lang.String> getAllowMethods()

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

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

getAllowOrigins

default java.util.List<java.lang.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

default java.util.List<java.lang.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

default java.lang.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

static CfnUrl.CorsProperty.Builder builder()

Returns:

a CfnUrl.CorsProperty.Builder of CfnUrl.CorsProperty