Interface CfnResponseHeadersPolicy.ICorsConfigProperty

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

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnResponseHeadersPolicy.ICorsConfigProperty

Syntax (vb)

Public Interface CfnResponseHeadersPolicy.ICorsConfigProperty

Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CloudFront;

             var corsConfigProperty = new CorsConfigProperty {
                 AccessControlAllowCredentials = false,
                 AccessControlAllowHeaders = new AccessControlAllowHeadersProperty {
                     Items = new [] { "items" }
                 },
                 AccessControlAllowMethods = new AccessControlAllowMethodsProperty {
                     Items = new [] { "items" }
                 },
                 AccessControlAllowOrigins = new AccessControlAllowOriginsProperty {
                     Items = new [] { "items" }
                 },
                 OriginOverride = false,

                 // the properties below are optional
                 AccessControlExposeHeaders = new AccessControlExposeHeadersProperty {
                     Items = new [] { "items" }
                 },
                 AccessControlMaxAgeSec = 123
             };

Synopsis

Properties

AccessControlAllowCredentials	A Boolean that CloudFront uses as the value for the `Access-Control-Allow-Credentials` HTTP response header.
AccessControlAllowHeaders	A list of HTTP header names that CloudFront includes as values for the `Access-Control-Allow-Headers` HTTP response header.
AccessControlAllowMethods	A list of HTTP methods that CloudFront includes as values for the `Access-Control-Allow-Methods` HTTP response header.
AccessControlAllowOrigins	A list of origins (domain names) that CloudFront can use as the value for the `Access-Control-Allow-Origin` HTTP response header.
AccessControlExposeHeaders	A list of HTTP headers that CloudFront includes as values for the `Access-Control-Expose-Headers` HTTP response header.
AccessControlMaxAgeSec	A number that CloudFront uses as the value for the `Access-Control-Max-Age` HTTP response header.
OriginOverride	A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.

Properties

AccessControlAllowCredentials

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

object AccessControlAllowCredentials { get; }

Property Value

object

Remarks

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

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

Type union: either bool or IResolvable

AccessControlAllowHeaders

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

object AccessControlAllowHeaders { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnResponseHeadersPolicy.IAccessControlAllowHeadersProperty

AccessControlAllowMethods

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

object AccessControlAllowMethods { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnResponseHeadersPolicy.IAccessControlAllowMethodsProperty

AccessControlAllowOrigins

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

object AccessControlAllowOrigins { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnResponseHeadersPolicy.IAccessControlAllowOriginsProperty

AccessControlExposeHeaders

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

object? AccessControlExposeHeaders { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnResponseHeadersPolicy.IAccessControlExposeHeadersProperty

AccessControlMaxAgeSec

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

double? AccessControlMaxAgeSec { get; }

Property Value

double?

Remarks

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

OriginOverride

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

object OriginOverride { get; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable