aws-cdk-lib.aws_cloudfront.HeadersReferrerPolicy

enum HeadersReferrerPolicy

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.HeadersReferrerPolicy
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#HeadersReferrerPolicy
Javasoftware.amazon.awscdk.services.cloudfront.HeadersReferrerPolicy
Pythonaws_cdk.aws_cloudfront.HeadersReferrerPolicy
TypeScript (source)aws-cdk-lib » aws_cloudfront » HeadersReferrerPolicy

Enum representing possible values of the Referrer-Policy HTTP response header.

Example

// Using an existing managed response headers policy
declare const bucketOrigin: origins.S3Origin;
new cloudfront.Distribution(this, 'myDistManagedPolicy', {
  defaultBehavior: {
    origin: bucketOrigin,
    responseHeadersPolicy: cloudfront.ResponseHeadersPolicy.CORS_ALLOW_ALL_ORIGINS,
  },
});

// Creating a custom response headers policy -- all parameters optional
const myResponseHeadersPolicy = new cloudfront.ResponseHeadersPolicy(this, 'ResponseHeadersPolicy', {
  responseHeadersPolicyName: 'MyPolicy',
  comment: 'A default policy',
  corsBehavior: {
    accessControlAllowCredentials: false,
    accessControlAllowHeaders: ['X-Custom-Header-1', 'X-Custom-Header-2'],
    accessControlAllowMethods: ['GET', 'POST'],
    accessControlAllowOrigins: ['*'],
    accessControlExposeHeaders: ['X-Custom-Header-1', 'X-Custom-Header-2'],
    accessControlMaxAge: Duration.seconds(600),
    originOverride: true,
  },
  customHeadersBehavior: {
    customHeaders: [
      { header: 'X-Amz-Date', value: 'some-value', override: true },
      { header: 'X-Amz-Security-Token', value: 'some-value', override: false },
    ],
  },
  securityHeadersBehavior: {
    contentSecurityPolicy: { contentSecurityPolicy: 'default-src https:;', override: true },
    contentTypeOptions: { override: true },
    frameOptions: { frameOption: cloudfront.HeadersFrameOption.DENY, override: true },
    referrerPolicy: { referrerPolicy: cloudfront.HeadersReferrerPolicy.NO_REFERRER, override: true },
    strictTransportSecurity: { accessControlMaxAge: Duration.seconds(600), includeSubdomains: true, override: true },
    xssProtection: { protection: true, modeBlock: true, reportUri: 'https://example.com/csp-report', override: true },
  },
  removeHeaders: ['Server'],
  serverTimingSamplingRate: 50,
});
new cloudfront.Distribution(this, 'myDistCustomPolicy', {
  defaultBehavior: {
    origin: bucketOrigin,
    responseHeadersPolicy: myResponseHeadersPolicy,
  },
});

Members

NameDescription
NO_REFERRERThe referrer policy is not set.
NO_REFERRER_WHEN_DOWNGRADEThe referrer policy is no-referrer-when-downgrade.
ORIGINThe referrer policy is origin.
ORIGIN_WHEN_CROSS_ORIGINThe referrer policy is origin-when-cross-origin.
SAME_ORIGINThe referrer policy is same-origin.
STRICT_ORIGINThe referrer policy is strict-origin.
STRICT_ORIGIN_WHEN_CROSS_ORIGINThe referrer policy is strict-origin-when-cross-origin.
UNSAFE_URLThe referrer policy is unsafe-url.

NO_REFERRER

The referrer policy is not set.


NO_REFERRER_WHEN_DOWNGRADE

The referrer policy is no-referrer-when-downgrade.


ORIGIN

The referrer policy is origin.


ORIGIN_WHEN_CROSS_ORIGIN

The referrer policy is origin-when-cross-origin.


SAME_ORIGIN

The referrer policy is same-origin.


STRICT_ORIGIN

The referrer policy is strict-origin.


STRICT_ORIGIN_WHEN_CROSS_ORIGIN

The referrer policy is strict-origin-when-cross-origin.


UNSAFE_URL

The referrer policy is unsafe-url.