Package software.amazon.awscdk.services.cloudfront

Interface CfnResponseHeadersPolicy.CorsConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResponseHeadersPolicy.CorsConfigProperty.Jsii$Proxy

Enclosing class:

CfnResponseHeadersPolicy

@Stability(Stable)
public static interface CfnResponseHeadersPolicy.CorsConfigProperty
extends software.amazon.jsii.JsiiSerializable

A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).

CloudFront adds these headers to HTTP responses that it sends for CORS requests that match a cache behavior associated with this response headers policy.

For more information about CORS, see Cross-Origin Resource Sharing (CORS) in the MDN Web Docs.

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.cloudfront.*;
 CorsConfigProperty corsConfigProperty = CorsConfigProperty.builder()
         .accessControlAllowCredentials(false)
         .accessControlAllowHeaders(AccessControlAllowHeadersProperty.builder()
                 .items(List.of("items"))
                 .build())
         .accessControlAllowMethods(AccessControlAllowMethodsProperty.builder()
                 .items(List.of("items"))
                 .build())
         .accessControlAllowOrigins(AccessControlAllowOriginsProperty.builder()
                 .items(List.of("items"))
                 .build())
         .originOverride(false)
         // the properties below are optional
         .accessControlExposeHeaders(AccessControlExposeHeadersProperty.builder()
                 .items(List.of("items"))
                 .build())
         .accessControlMaxAgeSec(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResponseHeadersPolicy.CorsConfigProperty.Builder	builder()
Object	getAccessControlAllowCredentials()	A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
Object	getAccessControlAllowHeaders()	A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
Object	getAccessControlAllowMethods()	A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
Object	getAccessControlAllowOrigins()	A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
default Object	getAccessControlExposeHeaders()	A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
default Number	getAccessControlMaxAgeSec()	A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
Object	getOriginOverride()	A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessControlAllowCredentials

@Stability(Stable)
@NotNull
Object getAccessControlAllowCredentials()

A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.

For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowcredentials

getAccessControlAllowHeaders

@Stability(Stable)
@NotNull
Object getAccessControlAllowHeaders()

A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.

For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowheaders

getAccessControlAllowMethods

@Stability(Stable)
@NotNull
Object getAccessControlAllowMethods()

A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.

For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolallowmethods

getAccessControlAllowOrigins

@Stability(Stable)
@NotNull
Object getAccessControlAllowOrigins()

A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.

For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolalloworigins

getOriginOverride

@Stability(Stable)
@NotNull
Object getOriginOverride()

A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-originoverride

getAccessControlExposeHeaders

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

A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.

For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolexposeheaders

getAccessControlMaxAgeSec

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

A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.

For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html#cfn-cloudfront-responseheaderspolicy-corsconfig-accesscontrolmaxagesec

builder

@Stability(Stable)
static CfnResponseHeadersPolicy.CorsConfigProperty.Builder builder()

Returns:

a CfnResponseHeadersPolicy.CorsConfigProperty.Builder of CfnResponseHeadersPolicy.CorsConfigProperty