software.amazon.awscdk.services.cloudfront

Class CloudFrontWebDistributionProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.CloudFrontWebDistributionProps.Builder

Enclosing interface:

CloudFrontWebDistributionProps

public static final class CloudFrontWebDistributionProps.Builder
extends java.lang.Object

A builder for CloudFrontWebDistributionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CloudFrontWebDistributionProps.Builder	aliasConfiguration(AliasConfiguration aliasConfiguration) Deprecated. see CloudFrontWebDistributionProps#viewerCertificate with ViewerCertificate#acmCertificate
CloudFrontWebDistributionProps	build() Builds the configured instance.
CloudFrontWebDistributionProps.Builder	comment(java.lang.String comment) Sets the value of CloudFrontWebDistributionProps.getComment()
CloudFrontWebDistributionProps.Builder	defaultRootObject(java.lang.String defaultRootObject) Sets the value of CloudFrontWebDistributionProps.getDefaultRootObject()
CloudFrontWebDistributionProps.Builder	enabled(java.lang.Boolean enabled) Sets the value of CloudFrontWebDistributionProps.getEnabled()
CloudFrontWebDistributionProps.Builder	enableIpV6(java.lang.Boolean enableIpV6) Sets the value of CloudFrontWebDistributionProps.getEnableIpV6()
CloudFrontWebDistributionProps.Builder	errorConfigurations(java.util.List<? extends CfnDistribution.CustomErrorResponseProperty> errorConfigurations) Sets the value of CloudFrontWebDistributionProps.getErrorConfigurations()
CloudFrontWebDistributionProps.Builder	geoRestriction(GeoRestriction geoRestriction) Sets the value of CloudFrontWebDistributionProps.getGeoRestriction()
CloudFrontWebDistributionProps.Builder	httpVersion(HttpVersion httpVersion) Sets the value of CloudFrontWebDistributionProps.getHttpVersion()
CloudFrontWebDistributionProps.Builder	loggingConfig(LoggingConfiguration loggingConfig) Sets the value of CloudFrontWebDistributionProps.getLoggingConfig()
CloudFrontWebDistributionProps.Builder	originConfigs(java.util.List<? extends SourceConfiguration> originConfigs) Sets the value of CloudFrontWebDistributionProps.getOriginConfigs()
CloudFrontWebDistributionProps.Builder	priceClass(PriceClass priceClass) Sets the value of CloudFrontWebDistributionProps.getPriceClass()
CloudFrontWebDistributionProps.Builder	viewerCertificate(ViewerCertificate viewerCertificate) Sets the value of CloudFrontWebDistributionProps.getViewerCertificate()
CloudFrontWebDistributionProps.Builder	viewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy) Sets the value of CloudFrontWebDistributionProps.getViewerProtocolPolicy()
CloudFrontWebDistributionProps.Builder	webAclId(java.lang.String webAclId) Sets the value of CloudFrontWebDistributionProps#getWebAclId

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

originConfigs

public CloudFrontWebDistributionProps.Builder originConfigs(java.util.List<? extends SourceConfiguration> originConfigs)

Sets the value of CloudFrontWebDistributionProps.getOriginConfigs()

Parameters:

originConfigs - The origin configurations for this distribution. This parameter is required. Behaviors are a part of the origin.

Returns:

this

aliasConfiguration

@Deprecated
public CloudFrontWebDistributionProps.Builder aliasConfiguration(AliasConfiguration aliasConfiguration)

Deprecated. see CloudFrontWebDistributionProps#viewerCertificate with ViewerCertificate#acmCertificate

Sets the value of CloudFrontWebDistributionProps.getAliasConfiguration()

Parameters:

aliasConfiguration - AliasConfiguration is used to configured CloudFront to respond to requests on custom domain names.

Returns:

this

comment

public CloudFrontWebDistributionProps.Builder comment(java.lang.String comment)

Sets the value of CloudFrontWebDistributionProps.getComment()

Parameters:

comment - A comment for this distribution in the CloudFront console.

Returns:

this

defaultRootObject

public CloudFrontWebDistributionProps.Builder defaultRootObject(java.lang.String defaultRootObject)

Sets the value of CloudFrontWebDistributionProps.getDefaultRootObject()

Parameters:

defaultRootObject - The default object to serve.

Returns:

this

enabled

public CloudFrontWebDistributionProps.Builder enabled(java.lang.Boolean enabled)

Sets the value of CloudFrontWebDistributionProps.getEnabled()

Parameters:

enabled - Enable or disable the distribution.

Returns:

this

enableIpV6

public CloudFrontWebDistributionProps.Builder enableIpV6(java.lang.Boolean enableIpV6)

Sets the value of CloudFrontWebDistributionProps.getEnableIpV6()

Parameters:

enableIpV6 - If your distribution should have IPv6 enabled.

Returns:

this

errorConfigurations

public CloudFrontWebDistributionProps.Builder errorConfigurations(java.util.List<? extends CfnDistribution.CustomErrorResponseProperty> errorConfigurations)

Sets the value of CloudFrontWebDistributionProps.getErrorConfigurations()

Parameters:

errorConfigurations - 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.

Returns:

this

geoRestriction

public CloudFrontWebDistributionProps.Builder geoRestriction(GeoRestriction geoRestriction)

Sets the value of CloudFrontWebDistributionProps.getGeoRestriction()

Parameters:

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

Returns:

this

httpVersion

public CloudFrontWebDistributionProps.Builder httpVersion(HttpVersion httpVersion)

Sets the value of CloudFrontWebDistributionProps.getHttpVersion()

Parameters:

httpVersion - The max supported HTTP Versions.

Returns:

this

loggingConfig

public CloudFrontWebDistributionProps.Builder loggingConfig(LoggingConfiguration loggingConfig)

Sets the value of CloudFrontWebDistributionProps.getLoggingConfig()

Parameters:

loggingConfig - 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.

Returns:

this

priceClass

public CloudFrontWebDistributionProps.Builder priceClass(PriceClass priceClass)

Sets the value of CloudFrontWebDistributionProps.getPriceClass()

Parameters:

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

Returns:

this

viewerCertificate

public CloudFrontWebDistributionProps.Builder viewerCertificate(ViewerCertificate viewerCertificate)

Sets the value of CloudFrontWebDistributionProps.getViewerCertificate()

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.

Returns:

this

viewerProtocolPolicy

public CloudFrontWebDistributionProps.Builder viewerProtocolPolicy(ViewerProtocolPolicy viewerProtocolPolicy)

Sets the value of CloudFrontWebDistributionProps.getViewerProtocolPolicy()

Parameters:

viewerProtocolPolicy - The default viewer policy for incoming clients.

Returns:

this

webAclId

public CloudFrontWebDistributionProps.Builder webAclId(java.lang.String webAclId)

Sets the value of CloudFrontWebDistributionProps#getWebAclId

Parameters:

webAclId - 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.

Returns:

this

build

public CloudFrontWebDistributionProps build()

Builds the configured instance.

Returns:

a new instance of CloudFrontWebDistributionProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided