Package software.amazon.awsconstructs.services.cloudfrontapigateway

Interface CloudFrontToApiGatewayProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFrontToApiGatewayProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.90.0 (build d6bdb4d)",
           date="2023-10-14T14:17:03.346Z")
public interface CloudFrontToApiGatewayProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CloudFrontToApiGatewayProps.Builder	builder()
default Object	getCloudFrontDistributionProps()	Optional user provided props to override the default props.
default software.amazon.awscdk.services.s3.BucketProps	getCloudFrontLoggingBucketProps()	Optional user provided props to override the default props for the CloudFront Logging Bucket.
software.amazon.awscdk.services.apigateway.RestApi	getExistingApiGatewayObj()	Existing instance of api.RestApi object.
default Boolean	getInsertHttpSecurityHeaders()	Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from cloudfront.
default software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicyProps	getResponseHeadersPolicyProps()	Optional user provided configuration that cloudfront applies to all http responses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExistingApiGatewayObj

@NotNull
software.amazon.awscdk.services.apigateway.RestApi getExistingApiGatewayObj()

Existing instance of api.RestApi object.

Default: - None

getCloudFrontDistributionProps

@Nullable
default Object getCloudFrontDistributionProps()

Optional user provided props to override the default props.

Default: - Default props are used

getCloudFrontLoggingBucketProps

@Nullable
default software.amazon.awscdk.services.s3.BucketProps getCloudFrontLoggingBucketProps()

Optional user provided props to override the default props for the CloudFront Logging Bucket.

Default: - Default props are used

getInsertHttpSecurityHeaders

@Nullable
default Boolean getInsertHttpSecurityHeaders()

Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from cloudfront.

Turning this on will inject default headers and is mutually exclusive with passing custom security headers via the responseHeadersPolicyProps parameter.

Default: - true

getResponseHeadersPolicyProps

@Nullable
default software.amazon.awscdk.services.cloudfront.ResponseHeadersPolicyProps getResponseHeadersPolicyProps()

Optional user provided configuration that cloudfront applies to all http responses.

Can be used to pass a custom ResponseSecurityHeadersBehavior, ResponseCustomHeadersBehavior or ResponseHeadersCorsBehavior to the cloudfront distribution.

Passing a custom ResponseSecurityHeadersBehavior is mutually exclusive with turning on the default security headers via insertHttpSecurityHeaders prop. Will throw an error if both insertHttpSecurityHeaders is set to true and ResponseSecurityHeadersBehavior is passed.

Default: - undefined

builder

static CloudFrontToApiGatewayProps.Builder builder()

Returns:

a CloudFrontToApiGatewayProps.Builder of CloudFrontToApiGatewayProps