software.amazon.awssdk.services.lambda.model

Class Cors

java.lang.Object

software.amazon.awssdk.services.lambda.model.Cors

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Cors.Builder,Cors>

@Generated(value="software.amazon.awssdk:codegen")
public final class Cors
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Cors.Builder,Cors>

The cross-origin resource sharing (CORS) settings for your Lambda 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Cors.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowCredentials() Whether to allow cookies or other credentials in requests to your function URL.
List<String>	allowHeaders() The HTTP headers that origins can include in requests to your function URL.
List<String>	allowMethods() The HTTP methods that are allowed when calling your function URL.
List<String>	allowOrigins() The origins that can access your function URL.
static Cors.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exposeHeaders() The HTTP headers in your function response that you want to expose to origins that call your function URL.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowHeaders() For responses, this returns true if the service returned a value for the AllowHeaders property.
boolean	hasAllowMethods() For responses, this returns true if the service returned a value for the AllowMethods property.
boolean	hasAllowOrigins() For responses, this returns true if the service returned a value for the AllowOrigins property.
boolean	hasExposeHeaders() For responses, this returns true if the service returned a value for the ExposeHeaders property.
int	hashCode()
Integer	maxAge() The maximum amount of time, in seconds, that web browsers can cache results of a preflight request.
List<SdkField<?>>	sdkFields()
static Class<? extends Cors.Builder>	serializableBuilderClass()
Cors.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

allowCredentials

public final Boolean allowCredentials()

Whether to allow cookies or other credentials in requests to your function URL. The default is false .

Returns:

Whether to allow cookies or other credentials in requests to your function URL. The default is false.

hasAllowHeaders

public final boolean hasAllowHeaders()

For responses, this returns true if the service returned a value for the AllowHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

allowHeaders

public final List<String> allowHeaders()

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowHeaders() method.

Returns:

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

hasAllowMethods

public final boolean hasAllowMethods()

For responses, this returns true if the service returned a value for the AllowMethods property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

allowMethods

public final List<String> allowMethods()

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowMethods() method.

Returns:

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

hasAllowOrigins

public final boolean hasAllowOrigins()

For responses, this returns true if the service returned a value for the AllowOrigins property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

allowOrigins

public final List<String> allowOrigins()

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 using the wildcard character (*).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowOrigins() method.

Returns:

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 using the wildcard character (*).

hasExposeHeaders

public final boolean hasExposeHeaders()

For responses, this returns true if the service returned a value for the ExposeHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

exposeHeaders

public final List<String> exposeHeaders()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExposeHeaders() method.

Returns:

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.

maxAge

public final Integer maxAge()

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.

Returns:

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.

toBuilder

public Cors.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Cors.Builder,Cors>

builder

public static Cors.Builder builder()

serializableBuilderClass

public static Class<? extends Cors.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo