ResponseHeadersPolicyProps

All Known Implementing Classes:: ResponseHeadersPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:07.411Z")
public interface ResponseHeadersPolicyProps

Properties for creating a Response Headers Policy.

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`	`ResponseHeadersPolicyProps.Builder` A builder for `ResponseHeadersPolicyProps`
`static class`	`ResponseHeadersPolicyProps.Jsii$Proxy` An implementation for `ResponseHeadersPolicyProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static ResponseHeadersPolicyProps.Builder`	`builder()`
`default java.lang.String`	`getComment()` A comment to describe the response headers policy.
`default ResponseHeadersCorsBehavior`	`getCorsBehavior()` A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
`default ResponseCustomHeadersBehavior`	`getCustomHeadersBehavior()` A configuration for a set of custom HTTP response headers.
`default java.lang.String`	`getResponseHeadersPolicyName()` A unique name to identify the response headers policy.
`default ResponseSecurityHeadersBehavior`	`getSecurityHeadersBehavior()` A configuration for a set of security-related HTTP response headers.

- Method Detail
  - getComment
```
default java.lang.String getComment()
```
    A comment to describe the response headers policy.
    Default: - no comment
  - getCorsBehavior
```
default ResponseHeadersCorsBehavior getCorsBehavior()
```
    A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
    Default: - no cors behavior
  - getCustomHeadersBehavior
```
default ResponseCustomHeadersBehavior getCustomHeadersBehavior()
```
    A configuration for a set of custom HTTP response headers.
    Default: - no custom headers behavior
  - getResponseHeadersPolicyName
```
default java.lang.String getResponseHeadersPolicyName()
```
    A unique name to identify the response headers policy.
    Default: - generated from the `id`
  - getSecurityHeadersBehavior
```
default ResponseSecurityHeadersBehavior getSecurityHeadersBehavior()
```
    A configuration for a set of security-related HTTP response headers.
    Default: - no security headers behavior
  - builder
```
static ResponseHeadersPolicyProps.Builder builder()
```
    Returns:
    
    a ResponseHeadersPolicyProps.Builder of ResponseHeadersPolicyProps

Interface ResponseHeadersPolicyProps

Nested Class Summary

Method Summary

Method Detail

getComment

getCorsBehavior

getCustomHeadersBehavior

getResponseHeadersPolicyName

getSecurityHeadersBehavior

builder