Cors (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lambda.model.Cors

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Cors
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Cors()

Constructors
Constructor and Description
`Cors()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cors`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowCredentials()` Whether to allow cookies or other credentials in requests to your function URL.
`List<String>`	`getAllowHeaders()` The HTTP headers that origins can include in requests to your function URL.
`List<String>`	`getAllowMethods()` The HTTP methods that are allowed when calling your function URL.
`List<String>`	`getAllowOrigins()` The origins that can access your function URL.
`List<String>`	`getExposeHeaders()` The HTTP headers in your function response that you want to expose to origins that call your function URL.
`Integer`	`getMaxAge()` The maximum amount of time, in seconds, that web browsers can cache results of a preflight request.
`int`	`hashCode()`
`Boolean`	`isAllowCredentials()` Whether to allow cookies or other credentials in requests to your function URL.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowCredentials(Boolean allowCredentials)` Whether to allow cookies or other credentials in requests to your function URL.
`void`	`setAllowHeaders(Collection<String> allowHeaders)` The HTTP headers that origins can include in requests to your function URL.
`void`	`setAllowMethods(Collection<String> allowMethods)` The HTTP methods that are allowed when calling your function URL.
`void`	`setAllowOrigins(Collection<String> allowOrigins)` The origins that can access your function URL.
`void`	`setExposeHeaders(Collection<String> exposeHeaders)` The HTTP headers in your function response that you want to expose to origins that call your function URL.
`void`	`setMaxAge(Integer maxAge)` The maximum amount of time, in seconds, that web browsers can cache results of a preflight request.
`String`	`toString()` Returns a string representation of this object.
`Cors`	`withAllowCredentials(Boolean allowCredentials)` Whether to allow cookies or other credentials in requests to your function URL.
`Cors`	`withAllowHeaders(Collection<String> allowHeaders)` The HTTP headers that origins can include in requests to your function URL.
`Cors`	`withAllowHeaders(String... allowHeaders)` The HTTP headers that origins can include in requests to your function URL.
`Cors`	`withAllowMethods(Collection<String> allowMethods)` The HTTP methods that are allowed when calling your function URL.
`Cors`	`withAllowMethods(String... allowMethods)` The HTTP methods that are allowed when calling your function URL.
`Cors`	`withAllowOrigins(Collection<String> allowOrigins)` The origins that can access your function URL.
`Cors`	`withAllowOrigins(String... allowOrigins)` The origins that can access your function URL.
`Cors`	`withExposeHeaders(Collection<String> exposeHeaders)` The HTTP headers in your function response that you want to expose to origins that call your function URL.
`Cors`	`withExposeHeaders(String... exposeHeaders)` The HTTP headers in your function response that you want to expose to origins that call your function URL.
`Cors`	`withMaxAge(Integer maxAge)` The maximum amount of time, in seconds, that web browsers can cache results of a preflight request.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Cors
```
public Cors()
```
- Method Detail
  - setAllowCredentials
```
public void setAllowCredentials(Boolean allowCredentials)
```
    Whether to allow cookies or other credentials in requests to your function URL. The default is false .
    
    Parameters:
    
    allowCredentials - Whether to allow cookies or other credentials in requests to your function URL. The default is false.
  - getAllowCredentials
```
public Boolean getAllowCredentials()
```
    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.
  - withAllowCredentials
```
public Cors withAllowCredentials(Boolean allowCredentials)
```
    Whether to allow cookies or other credentials in requests to your function URL. The default is false .
    
    Parameters:
    
    allowCredentials - Whether to allow cookies or other credentials in requests to your function URL. The default is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAllowCredentials
```
public Boolean isAllowCredentials()
```
    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.
  - getAllowHeaders
```
public List<String> getAllowHeaders()
```
    The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
    
    Returns:
    
    The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
  - setAllowHeaders
```
public void setAllowHeaders(Collection<String> allowHeaders)
```
    The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
    
    Parameters:
    
    allowHeaders - The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive, X-Custom-Header.
  - withAllowHeaders
```
public Cors withAllowHeaders(String... allowHeaders)
```
    The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowHeaders(java.util.Collection) or withAllowHeaders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    allowHeaders - The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive, X-Custom-Header.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowHeaders
```
public Cors withAllowHeaders(Collection<String> allowHeaders)
```
    The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
    
    Parameters:
    
    allowHeaders - The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive, X-Custom-Header.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowMethods
```
public List<String> getAllowMethods()
```
    The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
    
    Returns:
    
    The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
  - setAllowMethods
```
public void setAllowMethods(Collection<String> allowMethods)
```
    The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
    
    Parameters:
    
    allowMethods - The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
  - withAllowMethods
```
public Cors withAllowMethods(String... allowMethods)
```
    The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowMethods(java.util.Collection) or withAllowMethods(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    allowMethods - The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowMethods
```
public Cors withAllowMethods(Collection<String> allowMethods)
```
    The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
    
    Parameters:
    
    allowMethods - The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowOrigins
```
public 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 using the wildcard character (*).
    
    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 (*).
  - setAllowOrigins
```
public void setAllowOrigins(Collection<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 (*).
    
    Parameters:
    
    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 (*).
  - withAllowOrigins
```
public Cors withAllowOrigins(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 (*).
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowOrigins(java.util.Collection) or withAllowOrigins(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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 (*).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowOrigins
```
public Cors withAllowOrigins(Collection<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 (*).
    
    Parameters:
    
    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 (*).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExposeHeaders
```
public 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.
    
    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.
  - setExposeHeaders
```
public void setExposeHeaders(Collection<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.
    
    Parameters:
    
    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.
  - withExposeHeaders
```
public Cors withExposeHeaders(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setExposeHeaders(java.util.Collection) or withExposeHeaders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExposeHeaders
```
public Cors withExposeHeaders(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxAge
```
public void setMaxAge(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.
    
    Parameters:
    
    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.
  - getMaxAge
```
public Integer getMaxAge()
```
    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.
  - withMaxAge
```
public Cors withMaxAge(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Cors clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class Cors

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cors

Method Detail

setAllowCredentials

getAllowCredentials

withAllowCredentials

isAllowCredentials

getAllowHeaders

setAllowHeaders

withAllowHeaders

withAllowHeaders

getAllowMethods

setAllowMethods

withAllowMethods

withAllowMethods

getAllowOrigins

setAllowOrigins

withAllowOrigins

withAllowOrigins

getExposeHeaders

setExposeHeaders

withExposeHeaders

withExposeHeaders

setMaxAge

getMaxAge

withMaxAge

toString

equals

hashCode

clone

marshall