aws-cdk-lib.aws_cloudfront.CfnResponseHeadersPolicy.CorsConfigProperty

interface CorsConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.CfnResponseHeadersPolicy.CorsConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnResponseHeadersPolicy_CorsConfigProperty
Javasoftware.amazon.awscdk.services.cloudfront.CfnResponseHeadersPolicy.CorsConfigProperty
Pythonaws_cdk.aws_cloudfront.CfnResponseHeadersPolicy.CorsConfigProperty
TypeScript aws-cdk-lib » aws_cloudfront » CfnResponseHeadersPolicy » CorsConfigProperty

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 { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const corsConfigProperty: cloudfront.CfnResponseHeadersPolicy.CorsConfigProperty = {
  accessControlAllowCredentials: false,
  accessControlAllowHeaders: {
    items: ['items'],
  },
  accessControlAllowMethods: {
    items: ['items'],
  },
  accessControlAllowOrigins: {
    items: ['items'],
  },
  originOverride: false,

  // the properties below are optional
  accessControlExposeHeaders: {
    items: ['items'],
  },
  accessControlMaxAgeSec: 123,
};

Properties

NameTypeDescription
accessControlAllowCredentialsboolean | IResolvableA Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
accessControlAllowHeadersIResolvable | AccessControlAllowHeadersPropertyA list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
accessControlAllowMethodsIResolvable | AccessControlAllowMethodsPropertyA list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
accessControlAllowOriginsIResolvable | AccessControlAllowOriginsPropertyA list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
originOverrideboolean | IResolvableA Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
accessControlExposeHeaders?IResolvable | AccessControlExposeHeadersPropertyA list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
accessControlMaxAgeSec?numberA number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.

accessControlAllowCredentials

Type: boolean | IResolvable

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.


accessControlAllowHeaders

Type: IResolvable | AccessControlAllowHeadersProperty

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.


accessControlAllowMethods

Type: IResolvable | AccessControlAllowMethodsProperty

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.


accessControlAllowOrigins

Type: IResolvable | AccessControlAllowOriginsProperty

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.


originOverride

Type: boolean | IResolvable

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


accessControlExposeHeaders?

Type: IResolvable | AccessControlExposeHeadersProperty (optional)

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.


accessControlMaxAgeSec?

Type: number (optional)

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.