CloudFrontWebDistributionProps

All Known Implementing Classes:: CloudFrontWebDistributionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.062Z")
public interface CloudFrontWebDistributionProps

Example:

 Bucket sourceBucket;
 ViewerCertificate viewerCertificate = ViewerCertificate.fromIamCertificate("MYIAMROLEIDENTIFIER", ViewerCertificateOptions.builder()
         .aliases(List.of("MYALIAS"))
         .build());
 CloudFrontWebDistribution.Builder.create(this, "MyCfWebDistribution")
         .originConfigs(List.of(SourceConfiguration.builder()
                 .s3OriginSource(S3OriginConfig.builder()
                         .s3BucketSource(sourceBucket)
                         .build())
                 .behaviors(List.of(Behavior.builder().isDefaultBehavior(true).build()))
                 .build()))
         .viewerCertificate(viewerCertificate)
         .build();

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

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

- Method Detail
  - getOriginConfigs
```
java.util.List<SourceConfiguration> getOriginConfigs()
```
    The origin configurations for this distribution.
    Behaviors are a part of the origin.
  - getAliasConfiguration
```
@Deprecated
default AliasConfiguration getAliasConfiguration()
```
    Deprecated. see CloudFrontWebDistributionProps#viewerCertificate with ViewerCertificate#acmCertificate
    
    (deprecated) AliasConfiguration is used to configured CloudFront to respond to requests on custom domain names.
    Default: - None.
  - getComment
```
default java.lang.String getComment()
```
    A comment for this distribution in the CloudFront console.
    Default: - No comment is added to distribution.
  - getDefaultRootObject
```
default java.lang.String getDefaultRootObject()
```
    The default object to serve.
    Default: - "index.html" is served.
  - getEnabled
```
default java.lang.Boolean getEnabled()
```
    Enable or disable the distribution.
    Default: true
  - getEnableIpV6
```
default java.lang.Boolean getEnableIpV6()
```
    If your distribution should have IPv6 enabled.
    Default: true
  - getErrorConfigurations
```
default java.util.List<CfnDistribution.CustomErrorResponseProperty> getErrorConfigurations()
```
    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
```
default GeoRestriction getGeoRestriction()
```
    Controls the countries in which your content is distributed.
    Default: No geo restriction
  - getHttpVersion
```
default HttpVersion getHttpVersion()
```
    The max supported HTTP Versions.
    Default: HttpVersion.HTTP2
  - getLoggingConfig
```
default LoggingConfiguration getLoggingConfig()
```
    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
```
default PriceClass getPriceClass()
```
    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
```
default ViewerCertificate getViewerCertificate()
```
    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
```
default ViewerProtocolPolicy getViewerProtocolPolicy()
```
    The default viewer policy for incoming clients.
    Default: RedirectToHTTPs
  - getWebACLId
```
default java.lang.String getWebACLId()
```
    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
```
static CloudFrontWebDistributionProps.Builder builder()
```
    Returns:
    
    a CloudFrontWebDistributionProps.Builder of CloudFrontWebDistributionProps

Interface CloudFrontWebDistributionProps

Nested Class Summary

Method Summary

Method Detail

getOriginConfigs

getAliasConfiguration

getComment

getDefaultRootObject

getEnabled

getEnableIpV6

getErrorConfigurations

getGeoRestriction

getHttpVersion

getLoggingConfig

getPriceClass

getViewerCertificate

getViewerProtocolPolicy

getWebACLId

builder