software.amazon.awscdk.services.cloudfront

Interface ResponseHeadersStrictTransportSecurity

All Known Implementing Classes:

ResponseHeadersStrictTransportSecurity.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.653Z")
public interface ResponseHeadersStrictTransportSecurity

Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.

Example:

 // Using an existing managed response headers policy
 S3Origin bucketOrigin;
 Distribution.Builder.create(this, "myDistManagedPolicy")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(bucketOrigin)
                 .responseHeadersPolicy(ResponseHeadersPolicy.CORS_ALLOW_ALL_ORIGINS)
                 .build())
         .build();
 // Creating a custom response headers policy -- all parameters optional
 ResponseHeadersPolicy myResponseHeadersPolicy = ResponseHeadersPolicy.Builder.create(this, "ResponseHeadersPolicy")
         .responseHeadersPolicyName("MyPolicy")
         .comment("A default policy")
         .corsBehavior(ResponseHeadersCorsBehavior.builder()
                 .accessControlAllowCredentials(false)
                 .accessControlAllowHeaders(List.of("X-Custom-Header-1", "X-Custom-Header-2"))
                 .accessControlAllowMethods(List.of("GET", "POST"))
                 .accessControlAllowOrigins(List.of("*"))
                 .accessControlExposeHeaders(List.of("X-Custom-Header-1", "X-Custom-Header-2"))
                 .accessControlMaxAge(Duration.seconds(600))
                 .originOverride(true)
                 .build())
         .customHeadersBehavior(ResponseCustomHeadersBehavior.builder()
                 .customHeaders(List.of(ResponseCustomHeader.builder().header("X-Amz-Date").value("some-value").override(true).build(), ResponseCustomHeader.builder().header("X-Amz-Security-Token").value("some-value").override(false).build()))
                 .build())
         .securityHeadersBehavior(ResponseSecurityHeadersBehavior.builder()
                 .contentSecurityPolicy(ResponseHeadersContentSecurityPolicy.builder().contentSecurityPolicy("default-src https:;").override(true).build())
                 .contentTypeOptions(ResponseHeadersContentTypeOptions.builder().override(true).build())
                 .frameOptions(ResponseHeadersFrameOptions.builder().frameOption(HeadersFrameOption.DENY).override(true).build())
                 .referrerPolicy(ResponseHeadersReferrerPolicy.builder().referrerPolicy(HeadersReferrerPolicy.NO_REFERRER).override(true).build())
                 .strictTransportSecurity(ResponseHeadersStrictTransportSecurity.builder().accessControlMaxAge(Duration.seconds(600)).includeSubdomains(true).override(true).build())
                 .xssProtection(ResponseHeadersXSSProtection.builder().protection(true).modeBlock(true).reportUri("https://example.com/csp-report").override(true).build())
                 .build())
         .build();
 Distribution.Builder.create(this, "myDistCustomPolicy")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(bucketOrigin)
                 .responseHeadersPolicy(myResponseHeadersPolicy)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ResponseHeadersStrictTransportSecurity.Builder	builder()
Duration	getAccessControlMaxAge() A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
default java.lang.Boolean	getIncludeSubdomains() A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
java.lang.Boolean	getOverride() A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
default java.lang.Boolean	getPreload() A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.

Method Detail

getAccessControlMaxAge

Duration getAccessControlMaxAge()

A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.

getOverride

java.lang.Boolean getOverride()

A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.

getIncludeSubdomains

default java.lang.Boolean getIncludeSubdomains()

A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.

Default: false

getPreload

default java.lang.Boolean getPreload()

A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.

Default: false

builder

static ResponseHeadersStrictTransportSecurity.Builder builder()

Returns:

a ResponseHeadersStrictTransportSecurity.Builder of ResponseHeadersStrictTransportSecurity