software.amazon.awscdk.services.cloudfront

Class CloudFrontWebDistribution.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.CloudFrontWebDistribution.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFrontWebDistribution>

Enclosing class:

CloudFrontWebDistribution

@Stability(value=Experimental)
public static final class CloudFrontWebDistribution.Builder
extends Object
implements software.amazon.jsii.Builder<CloudFrontWebDistribution>

(experimental) A fluent builder for CloudFrontWebDistribution.

Method Summary

Modifier and Type	Method and Description
CloudFrontWebDistribution	build()
CloudFrontWebDistribution.Builder	comment(String comment) (experimental) A comment for this distribution in the CloudFront console.
static CloudFrontWebDistribution.Builder	create(software.constructs.Construct scope, String id)
CloudFrontWebDistribution.Builder	defaultRootObject(String defaultRootObject) (experimental) The default object to serve.
CloudFrontWebDistribution.Builder	enableIpV6(Boolean enableIpV6) (experimental) If your distribution should have IPv6 enabled.
CloudFrontWebDistribution.Builder	errorConfigurations(List<? extends CfnDistribution.CustomErrorResponseProperty> errorConfigurations) (experimental) How CloudFront should handle requests that are not successful (eg PageNotFound).
CloudFrontWebDistribution.Builder	geoRestriction(GeoRestriction geoRestriction) (experimental) Controls the countries in which your content is distributed.
CloudFrontWebDistribution.Builder	httpVersion(HttpVersion httpVersion) (experimental) The max supported HTTP Versions.
CloudFrontWebDistribution.Builder	loggingConfig(LoggingConfiguration loggingConfig) (experimental) Optional - if we should enable logging.
CloudFrontWebDistribution.Builder	originConfigs(List<? extends SourceConfiguration> originConfigs) (experimental) The origin configurations for this distribution.
CloudFrontWebDistribution.Builder	priceClass(PriceClass priceClass) (experimental) The price class for the distribution (this impacts how many locations CloudFront uses for your distribution, and billing).
CloudFrontWebDistribution.Builder	viewerCertificate(ViewerCertificate viewerCertificate) (experimental) Specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.
CloudFrontWebDistribution.Builder	viewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy) (experimental) The default viewer policy for incoming clients.
CloudFrontWebDistribution.Builder	webAclId(String webAclId) (experimental) Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static CloudFrontWebDistribution.Builder create(software.constructs.Construct scope,
                                                                                      String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CloudFrontWebDistribution.Builder.

originConfigs

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder originConfigs(List<? extends SourceConfiguration> originConfigs)

(experimental) The origin configurations for this distribution.

Behaviors are a part of the origin.

Parameters:

originConfigs - The origin configurations for this distribution. This parameter is required.

Returns:

this

comment

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder comment(String comment)

(experimental) A comment for this distribution in the CloudFront console.

Default: - No comment is added to distribution.

Parameters:

comment - A comment for this distribution in the CloudFront console. This parameter is required.

Returns:

this

defaultRootObject

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder defaultRootObject(String defaultRootObject)

(experimental) The default object to serve.

Default: - "index.html" is served.

Parameters:

defaultRootObject - The default object to serve. This parameter is required.

Returns:

this

enableIpV6

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder enableIpV6(Boolean enableIpV6)

(experimental) If your distribution should have IPv6 enabled.

Default: true

Parameters:

enableIpV6 - If your distribution should have IPv6 enabled. This parameter is required.

Returns:

this

errorConfigurations

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder errorConfigurations(List<? extends CfnDistribution.CustomErrorResponseProperty> errorConfigurations)

(experimental) How CloudFront should handle requests that are not successful (eg PageNotFound).

By default, CloudFront does not replace HTTP status codes in the 4xx and 5xx range with custom error messages. CloudFront does not cache HTTP status codes.

Default: - No custom error configuration.

Parameters:

errorConfigurations - How CloudFront should handle requests that are not successful (eg PageNotFound). This parameter is required.

Returns:

this

geoRestriction

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder geoRestriction(GeoRestriction geoRestriction)

(experimental) Controls the countries in which your content is distributed.

Default: No geo restriction

Parameters:

geoRestriction - Controls the countries in which your content is distributed. This parameter is required.

Returns:

this

httpVersion

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder httpVersion(HttpVersion httpVersion)

(experimental) The max supported HTTP Versions.

Default: HttpVersion.HTTP2

Parameters:

httpVersion - The max supported HTTP Versions. This parameter is required.

Returns:

this

loggingConfig

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder loggingConfig(LoggingConfiguration loggingConfig)

(experimental) Optional - if we should enable logging.

You can pass an empty object ({}) to have us auto create a bucket for logging. Omission of this property indicates no logging is to be enabled.

Default: - no logging is enabled by default.

Parameters:

loggingConfig - Optional - if we should enable logging. This parameter is required.

Returns:

this

priceClass

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder priceClass(PriceClass priceClass)

(experimental) The price class for the distribution (this impacts how many locations CloudFront uses for your distribution, and billing).

Default: PriceClass.PRICE_CLASS_100 the cheapest option for CloudFront is picked by default.

Parameters:

priceClass - The price class for the distribution (this impacts how many locations CloudFront uses for your distribution, and billing). This parameter is required.

Returns:

this

viewerCertificate

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder viewerCertificate(ViewerCertificate viewerCertificate)

(experimental) Specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.

Default: ViewerCertificate.fromCloudFrontDefaultCertificate()

Parameters:

viewerCertificate - Specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority. This parameter is required.

Returns:

this

See Also:

https://aws.amazon.com/premiumsupport/knowledge-center/custom-ssl-certificate-cloudfront/

viewerProtocolPolicy

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder viewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)

(experimental) The default viewer policy for incoming clients.

Default: RedirectToHTTPs

Parameters:

viewerProtocolPolicy - The default viewer policy for incoming clients. This parameter is required.

Returns:

this

webAclId

@Stability(value=Experimental)
public CloudFrontWebDistribution.Builder webAclId(String webAclId)

(experimental) Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution.

To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.

To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

Default: - No AWS Web Application Firewall web access control list (web ACL).

Parameters:

webAclId - Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html#API_CreateDistribution_RequestParameters.

build

@Stability(value=Experimental)
public CloudFrontWebDistribution build()

Specified by:

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