software.amazon.awscdk.services.cloudfront

Interface CloudFrontWebDistributionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFrontWebDistributionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:50.288Z")
 @Stability(value=Experimental)
public interface CloudFrontWebDistributionProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CloudFrontWebDistributionProps.Builder	builder()
default String	getComment() (experimental) A comment for this distribution in the CloudFront console.
default String	getDefaultRootObject() (experimental) The default object to serve.
default Boolean	getEnableIpV6() (experimental) If your distribution should have IPv6 enabled.
default List<CfnDistribution.CustomErrorResponseProperty>	getErrorConfigurations() (experimental) How CloudFront should handle requests that are not successful (eg PageNotFound).
default GeoRestriction	getGeoRestriction() (experimental) Controls the countries in which your content is distributed.
default HttpVersion	getHttpVersion() (experimental) The max supported HTTP Versions.
default LoggingConfiguration	getLoggingConfig() (experimental) Optional - if we should enable logging.
List<SourceConfiguration>	getOriginConfigs() (experimental) The origin configurations for this distribution.
default PriceClass	getPriceClass() (experimental) The price class for the distribution (this impacts how many locations CloudFront uses for your distribution, and billing).
default ViewerCertificate	getViewerCertificate() (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 ViewerProtocolPolicy	getViewerProtocolPolicy() (experimental) The default viewer policy for incoming clients.
default String	getWebACLId() (experimental) Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOriginConfigs

@Stability(value=Experimental)
 @NotNull
List<SourceConfiguration> getOriginConfigs()

(experimental) The origin configurations for this distribution.

Behaviors are a part of the origin.

getComment

@Stability(value=Experimental)
 @Nullable
default String getComment()

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

Default: - No comment is added to distribution.

getDefaultRootObject

@Stability(value=Experimental)
 @Nullable
default String getDefaultRootObject()

(experimental) The default object to serve.

Default: - "index.html" is served.

getEnableIpV6

@Stability(value=Experimental)
 @Nullable
default Boolean getEnableIpV6()

(experimental) If your distribution should have IPv6 enabled.

Default: true

getErrorConfigurations

@Stability(value=Experimental)
 @Nullable
default List<CfnDistribution.CustomErrorResponseProperty> getErrorConfigurations()

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

getGeoRestriction

@Stability(value=Experimental)
 @Nullable
default GeoRestriction getGeoRestriction()

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

Default: No geo restriction

getHttpVersion

@Stability(value=Experimental)
 @Nullable
default HttpVersion getHttpVersion()

(experimental) The max supported HTTP Versions.

Default: HttpVersion.HTTP2

getLoggingConfig

@Stability(value=Experimental)
 @Nullable
default LoggingConfiguration getLoggingConfig()

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

getPriceClass

@Stability(value=Experimental)
 @Nullable
default PriceClass getPriceClass()

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

getViewerCertificate

@Stability(value=Experimental)
 @Nullable
default ViewerCertificate getViewerCertificate()

(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()

See Also:

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

getViewerProtocolPolicy

@Stability(value=Experimental)
 @Nullable
default ViewerProtocolPolicy getViewerProtocolPolicy()

(experimental) The default viewer policy for incoming clients.

Default: RedirectToHTTPs

getWebACLId

@Stability(value=Experimental)
 @Nullable
default String getWebACLId()

(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).

See Also:

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

builder

@Stability(value=Experimental)
static CloudFrontWebDistributionProps.Builder builder()

Returns:

a CloudFrontWebDistributionProps.Builder of CloudFrontWebDistributionProps