software.amazon.awsconstructs.services.cloudfronts3

Class CloudFrontToS3.Builder

java.lang.Object

software.amazon.awsconstructs.services.cloudfronts3.CloudFrontToS3.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFrontToS3>

Enclosing class:

CloudFrontToS3

public static final class CloudFrontToS3.Builder
extends Object
implements software.amazon.jsii.Builder<CloudFrontToS3>

A fluent builder for CloudFrontToS3.

Method Summary

Modifier and Type	Method and Description
CloudFrontToS3.Builder	bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps) Optional user provided props to override the default props for the S3 Bucket.
CloudFrontToS3	build()
CloudFrontToS3.Builder	cloudFrontDistributionProps(Object cloudFrontDistributionProps) Optional user provided props to override the default props.
CloudFrontToS3.Builder	cloudFrontLoggingBucketProps(software.amazon.awscdk.services.s3.BucketProps cloudFrontLoggingBucketProps) Optional user provided props to override the default props for the CloudFront Logging Bucket.
static CloudFrontToS3.Builder	create(software.constructs.Construct scope, String id)
CloudFrontToS3.Builder	existingBucketObj(software.amazon.awscdk.services.s3.IBucket existingBucketObj) Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.
CloudFrontToS3.Builder	insertHttpSecurityHeaders(Boolean insertHttpSecurityHeaders) Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from cloudfront.
CloudFrontToS3.Builder	loggingBucketProps(software.amazon.awscdk.services.s3.BucketProps loggingBucketProps) Optional user provided props to override the default props for the S3 Logging Bucket.
CloudFrontToS3.Builder	logS3AccessLogs(Boolean logS3AccessLogs) Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
CloudFrontToS3.Builder	originPath(String originPath) Optional user provided props to provide an originPath that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CloudFrontToS3.Builder create(software.constructs.Construct scope,
                                            String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of CloudFrontToS3.Builder.

bucketProps

public CloudFrontToS3.Builder bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps)

Optional user provided props to override the default props for the S3 Bucket.

Default: - Default props are used

Parameters:

bucketProps - Optional user provided props to override the default props for the S3 Bucket. This parameter is required.

Returns:

this

cloudFrontDistributionProps

public CloudFrontToS3.Builder cloudFrontDistributionProps(Object cloudFrontDistributionProps)

Optional user provided props to override the default props.

Default: - Default props are used

Parameters:

cloudFrontDistributionProps - Optional user provided props to override the default props. This parameter is required.

Returns:

this

cloudFrontLoggingBucketProps

public CloudFrontToS3.Builder cloudFrontLoggingBucketProps(software.amazon.awscdk.services.s3.BucketProps cloudFrontLoggingBucketProps)

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

Default: - Default props are used

Parameters:

cloudFrontLoggingBucketProps - Optional user provided props to override the default props for the CloudFront Logging Bucket. This parameter is required.

Returns:

this

existingBucketObj

public CloudFrontToS3.Builder existingBucketObj(software.amazon.awscdk.services.s3.IBucket existingBucketObj)

Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.

Default: - None

Parameters:

existingBucketObj - Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error. This parameter is required.

Returns:

this

insertHttpSecurityHeaders

public CloudFrontToS3.Builder insertHttpSecurityHeaders(Boolean insertHttpSecurityHeaders)

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

Default: - true

Parameters:

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

Returns:

this

loggingBucketProps

public CloudFrontToS3.Builder loggingBucketProps(software.amazon.awscdk.services.s3.BucketProps loggingBucketProps)

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

Default: - Default props are used

Parameters:

loggingBucketProps - Optional user provided props to override the default props for the S3 Logging Bucket. This parameter is required.

Returns:

this

logS3AccessLogs

public CloudFrontToS3.Builder logS3AccessLogs(Boolean logS3AccessLogs)

Whether to turn on Access Logs for the S3 bucket with the associated storage costs.

Enabling Access Logging is a best practice.

Default: - true

Parameters:

logS3AccessLogs - Whether to turn on Access Logs for the S3 bucket with the associated storage costs. This parameter is required.

Returns:

this

originPath

public CloudFrontToS3.Builder originPath(String originPath)

Optional user provided props to provide an originPath that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

The string should start with a /, for example /production.

Parameters:

originPath - Optional user provided props to provide an originPath that CloudFront appends to the origin domain name when CloudFront requests content from the origin. This parameter is required.

Returns:

this

build

public CloudFrontToS3 build()

Specified by:

build in interface software.amazon.jsii.Builder<CloudFrontToS3>