software.amazon.awscdk.services.cloudfront

Interface DistributionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DistributionProps.Jsii$Proxy

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

(experimental) Properties for a Distribution.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DistributionProps.Builder	builder()
default Map<String,BehaviorOptions>	getAdditionalBehaviors() (experimental) Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to.
default ICertificate	getCertificate() (experimental) A certificate to associate with the distribution.
default String	getComment() (experimental) Any comments you want to include about the distribution.
BehaviorOptions	getDefaultBehavior() (experimental) The default behavior for the distribution.
default String	getDefaultRootObject() (experimental) The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution.
default List<String>	getDomainNames() (experimental) Alternative domain names for this distribution.
default Boolean	getEnabled() (experimental) Enable or disable the distribution.
default Boolean	getEnableIpv6() (experimental) Whether CloudFront will respond to IPv6 DNS requests with an IPv6 address.
default Boolean	getEnableLogging() (experimental) Enable access logging for the distribution.
default List<ErrorResponse>	getErrorResponses() (experimental) How CloudFront should handle requests that are not successful (e.g., PageNotFound).
default GeoRestriction	getGeoRestriction() (experimental) Controls the countries in which your content is distributed.
default HttpVersion	getHttpVersion() (experimental) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.
default IBucket	getLogBucket() (experimental) The Amazon S3 bucket to store the access logs in.
default String	getLogFilePrefix() (experimental) An optional string that you want CloudFront to prefix to the access log filenames for this distribution.
default Boolean	getLogIncludesCookies() (experimental) Specifies whether you want CloudFront to include cookies in access logs.
default SecurityPolicyProtocol	getMinimumProtocolVersion() (experimental) The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections.
default PriceClass	getPriceClass() (experimental) The price class that corresponds with the maximum price that you want to pay for CloudFront service.
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

getDefaultBehavior

@Stability(value=Experimental)
 @NotNull
BehaviorOptions getDefaultBehavior()

(experimental) The default behavior for the distribution.

getAdditionalBehaviors

@Stability(value=Experimental)
 @Nullable
default Map<String,BehaviorOptions> getAdditionalBehaviors()

(experimental) Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to.

Default: - no additional behaviors are added.

getCertificate

@Stability(value=Experimental)
 @Nullable
default ICertificate getCertificate()

(experimental) A certificate to associate with the distribution.

The certificate must be located in N. Virginia (us-east-1).

Default: - the CloudFront wildcard certificate (*.cloudfront.net) will be used.

getComment

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

(experimental) Any comments you want to include about the distribution.

Default: - no comment

getDefaultRootObject

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

(experimental) The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution. If no default object is set, the request goes to the origin's root (e.g., example.com/).

Default: - no default root object

getDomainNames

@Stability(value=Experimental)
 @Nullable
default List<String> getDomainNames()

(experimental) Alternative domain names for this distribution.

If you want to use your own domain name, such as www.example.com, instead of the cloudfront.net domain name, you can add an alternate domain name to your distribution. If you attach a certificate to the distribution, you must add (at least one of) the domain names of the certificate to this list.

Default: - The distribution will only support the default generated name (e.g., d111111abcdef8.cloudfront.net)

getEnabled

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

(experimental) Enable or disable the distribution.

Default: true

getEnableIpv6

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

(experimental) Whether CloudFront will respond to IPv6 DNS requests with an IPv6 address.

If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

Default: true

getEnableLogging

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

(experimental) Enable access logging for the distribution.

Default: - false, unless `logBucket` is specified.

getErrorResponses

@Stability(value=Experimental)
 @Nullable
default List<ErrorResponse> getErrorResponses()

(experimental) How CloudFront should handle requests that are not successful (e.g., PageNotFound).

Default: - No custom error responses.

getGeoRestriction

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

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

Default: - No geographic restrictions

getHttpVersion

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

(experimental) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support server name identification (SNI).

Default: HttpVersion.HTTP2

getLogBucket

@Stability(value=Experimental)
 @Nullable
default IBucket getLogBucket()

(experimental) The Amazon S3 bucket to store the access logs in.

Default: - A bucket is created if `enableLogging` is true

getLogFilePrefix

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

(experimental) An optional string that you want CloudFront to prefix to the access log filenames for this distribution.

Default: - no prefix

getLogIncludesCookies

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

(experimental) Specifies whether you want CloudFront to include cookies in access logs.

Default: false

getMinimumProtocolVersion

@Stability(value=Experimental)
 @Nullable
default SecurityPolicyProtocol getMinimumProtocolVersion()

(experimental) The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections.

CloudFront serves your objects only to browsers or devices that support at least the SSL version that you specify.

Default: SecurityPolicyProtocol.TLS_V1_2_2019

getPriceClass

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

(experimental) The price class that corresponds with the maximum price that you want to pay for CloudFront service.

If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class.

Default: PriceClass.PRICE_CLASS_ALL

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 DistributionProps.Builder builder()

Returns:

a DistributionProps.Builder of DistributionProps