aws-cdk-lib.aws_cloudfront.CfnResponseHeadersPolicy.ResponseHeadersPolicyConfigProperty

interface ResponseHeadersPolicyConfigProperty

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

A response headers policy configuration.

A response headers policy configuration contains metadata about the response headers policy, and configurations for sets of HTTP response headers.

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 responseHeadersPolicyConfigProperty: cloudfront.CfnResponseHeadersPolicy.ResponseHeadersPolicyConfigProperty = {
  name: 'name',

  // the properties below are optional
  comment: 'comment',
  corsConfig: {
    accessControlAllowCredentials: false,
    accessControlAllowHeaders: {
      items: ['items'],
    },
    accessControlAllowMethods: {
      items: ['items'],
    },
    accessControlAllowOrigins: {
      items: ['items'],
    },
    originOverride: false,

    // the properties below are optional
    accessControlExposeHeaders: {
      items: ['items'],
    },
    accessControlMaxAgeSec: 123,
  },
  customHeadersConfig: {
    items: [{
      header: 'header',
      override: false,
      value: 'value',
    }],
  },
  removeHeadersConfig: {
    items: [{
      header: 'header',
    }],
  },
  securityHeadersConfig: {
    contentSecurityPolicy: {
      contentSecurityPolicy: 'contentSecurityPolicy',
      override: false,
    },
    contentTypeOptions: {
      override: false,
    },
    frameOptions: {
      frameOption: 'frameOption',
      override: false,
    },
    referrerPolicy: {
      override: false,
      referrerPolicy: 'referrerPolicy',
    },
    strictTransportSecurity: {
      accessControlMaxAgeSec: 123,
      override: false,

      // the properties below are optional
      includeSubdomains: false,
      preload: false,
    },
    xssProtection: {
      override: false,
      protection: false,

      // the properties below are optional
      modeBlock: false,
      reportUri: 'reportUri',
    },
  },
  serverTimingHeadersConfig: {
    enabled: false,

    // the properties below are optional
    samplingRate: 123,
  },
};

Properties

NameTypeDescription
namestringA name to identify the response headers policy.
comment?stringA comment to describe the response headers policy.
corsConfig?IResolvable | CorsConfigPropertyA configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
customHeadersConfig?IResolvable | CustomHeadersConfigPropertyA configuration for a set of custom HTTP response headers.
removeHeadersConfig?IResolvable | RemoveHeadersConfigPropertyA configuration for a set of HTTP headers to remove from the HTTP response.
securityHeadersConfig?IResolvable | SecurityHeadersConfigPropertyA configuration for a set of security-related HTTP response headers.
serverTimingHeadersConfig?IResolvable | ServerTimingHeadersConfigPropertyA configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.

name

Type: string

A name to identify the response headers policy.

The name must be unique for response headers policies in this AWS account .


comment?

Type: string (optional)

A comment to describe the response headers policy.

The comment cannot be longer than 128 characters.


corsConfig?

Type: IResolvable | CorsConfigProperty (optional)

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


customHeadersConfig?

Type: IResolvable | CustomHeadersConfigProperty (optional)

A configuration for a set of custom HTTP response headers.


removeHeadersConfig?

Type: IResolvable | RemoveHeadersConfigProperty (optional)

A configuration for a set of HTTP headers to remove from the HTTP response.


securityHeadersConfig?

Type: IResolvable | SecurityHeadersConfigProperty (optional)

A configuration for a set of security-related HTTP response headers.


serverTimingHeadersConfig?

Type: IResolvable | ServerTimingHeadersConfigProperty (optional)

A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.