Package software.amazon.awscdk.services.apigateway

Class CorsOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.CorsOptions.Jsii$Proxy

All Implemented Interfaces:

CorsOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CorsOptions

@Stability(Stable)
@Internal
public static final class CorsOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CorsOptions

An implementation for CorsOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.CorsOptions

CorsOptions.Builder, CorsOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CorsOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the CorsOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getAllowCredentials()	The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to frontend JavaScript code when the request's credentials mode (Request.credentials) is "include".
final List<String>	getAllowHeaders()	The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.
final List<String>	getAllowMethods()	The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.
final List<String>	getAllowOrigins()	Specifies the list of origins that are allowed to make requests to this resource.
final Boolean	getDisableCache()	Sets Access-Control-Max-Age to -1, which means that caching is disabled.
final List<String>	getExposeHeaders()	The Access-Control-Expose-Headers response header indicates which headers can be exposed as part of the response by listing their names.
final Duration	getMaxAge()	The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.
final Number	getStatusCode()	Specifies the response status code returned from the OPTIONS method.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CorsOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the CorsOptions.Builder.

Method Details

getAllowOrigins

public final List<String> getAllowOrigins()

Description copied from interface: CorsOptions

Specifies the list of origins that are allowed to make requests to this resource.

If you wish to allow all origins, specify Cors.ALL_ORIGINS or [ * ].

Responses will include the Access-Control-Allow-Origin response header. If Cors.ALL_ORIGINS is specified, the Vary: Origin response header will also be included.

Specified by:

getAllowOrigins in interface CorsOptions

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin

getAllowCredentials

public final Boolean getAllowCredentials()

Description copied from interface: CorsOptions

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to frontend JavaScript code when the request's credentials mode (Request.credentials) is "include".

When a request's credentials mode (Request.credentials) is "include", browsers will only expose the response to frontend JavaScript code if the Access-Control-Allow-Credentials value is true.

Credentials are cookies, authorization headers or TLS client certificates.

Default: false

Specified by:

getAllowCredentials in interface CorsOptions

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials

getAllowHeaders

public final List<String> getAllowHeaders()

Description copied from interface: CorsOptions

The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.

Default: Cors.DEFAULT_HEADERS

Specified by:

getAllowHeaders in interface CorsOptions

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers

getAllowMethods

public final List<String> getAllowMethods()

Description copied from interface: CorsOptions

The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.

If ANY is specified, it will be expanded to Cors.ALL_METHODS.

Default: Cors.ALL_METHODS

Specified by:

getAllowMethods in interface CorsOptions

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods

getDisableCache

public final Boolean getDisableCache()

Description copied from interface: CorsOptions

Sets Access-Control-Max-Age to -1, which means that caching is disabled.

This option cannot be used with maxAge.

Default: - cache is enabled

Specified by:

getDisableCache in interface CorsOptions

getExposeHeaders

public final List<String> getExposeHeaders()

Description copied from interface: CorsOptions

The Access-Control-Expose-Headers response header indicates which headers can be exposed as part of the response by listing their names.

If you want clients to be able to access other headers, you have to list them using the Access-Control-Expose-Headers header.

Default: - only the 6 CORS-safelisted response headers are exposed: Cache-Control, Content-Language, Content-Type, Expires, Last-Modified, Pragma

Specified by:

getExposeHeaders in interface CorsOptions

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers

getMaxAge

public final Duration getMaxAge()

Description copied from interface: CorsOptions

The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.

To disable caching altogether use disableCache: true.

Default: - browser-specific (see reference)

Specified by:

getMaxAge in interface CorsOptions

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age

getStatusCode

public final Number getStatusCode()

Description copied from interface: CorsOptions

Specifies the response status code returned from the OPTIONS method.

Default: 204

Specified by:

getStatusCode in interface CorsOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object