Package software.amazon.awscdk.services.cloudfront

Class DistributionProps.Builder

java.lang.Object
software.amazon.awscdk.services.cloudfront.DistributionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<DistributionProps>
Enclosing interface:
DistributionProps
@Stability(Stable) public static final class DistributionProps.Builder extends Object implements software.amazon.jsii.Builder<DistributionProps>
A builder for DistributionProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • defaultBehavior

      @Stability(Stable) public DistributionProps.Builder defaultBehavior(BehaviorOptions defaultBehavior)
      Sets the value of DistributionProps.getDefaultBehavior()
      Parameters:
      defaultBehavior - The default behavior for the distribution. This parameter is required.
      Returns:
      this

    • additionalBehaviors

      @Stability(Stable) public DistributionProps.Builder additionalBehaviors(Map<String,? extends BehaviorOptions> additionalBehaviors)
      Sets the value of DistributionProps.getAdditionalBehaviors()
      Parameters:
      additionalBehaviors - Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to.
      Returns:
      this

    • certificate

      @Stability(Stable) public DistributionProps.Builder certificate(ICertificate certificate)
      Sets the value of DistributionProps.getCertificate()
      Parameters:
      certificate - A certificate to associate with the distribution. The certificate must be located in N. Virginia (us-east-1).
      Returns:
      this

    • comment

      @Stability(Stable) public DistributionProps.Builder comment(String comment)
      Sets the value of DistributionProps.getComment()
      Parameters:
      comment - Any comments you want to include about the distribution.
      Returns:
      this

    • defaultRootObject

      @Stability(Stable) public DistributionProps.Builder defaultRootObject(String defaultRootObject)
      Sets the value of DistributionProps.getDefaultRootObject()
      Parameters:
      defaultRootObject - 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/).
      Returns:
      this

    • domainNames

      @Stability(Stable) public DistributionProps.Builder domainNames(List<String> domainNames)
      Sets the value of DistributionProps.getDomainNames()
      Parameters:
      domainNames - 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.
      Returns:
      this

    • enabled

      @Stability(Stable) public DistributionProps.Builder enabled(Boolean enabled)
      Sets the value of DistributionProps.getEnabled()
      Parameters:
      enabled - Enable or disable the distribution.
      Returns:
      this

    • enableIpv6

      @Stability(Stable) public DistributionProps.Builder enableIpv6(Boolean enableIpv6)
      Sets the value of DistributionProps.getEnableIpv6()
      Parameters:
      enableIpv6 - 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.
      Returns:
      this

    • enableLogging

      @Stability(Stable) public DistributionProps.Builder enableLogging(Boolean enableLogging)
      Sets the value of DistributionProps.getEnableLogging()
      Parameters:
      enableLogging - Enable access logging for the distribution.
      Returns:
      this

    • errorResponses

      @Stability(Stable) public DistributionProps.Builder errorResponses(List<? extends ErrorResponse> errorResponses)
      Sets the value of DistributionProps.getErrorResponses()
      Parameters:
      errorResponses - How CloudFront should handle requests that are not successful (e.g., PageNotFound).
      Returns:
      this

    • geoRestriction

      @Stability(Stable) public DistributionProps.Builder geoRestriction(GeoRestriction geoRestriction)
      Sets the value of DistributionProps.getGeoRestriction()
      Parameters:
      geoRestriction - Controls the countries in which your content is distributed.
      Returns:
      this

    • httpVersion

      @Stability(Stable) public DistributionProps.Builder httpVersion(HttpVersion httpVersion)
      Sets the value of DistributionProps.getHttpVersion()
      Parameters:
      httpVersion - 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).
      Returns:
      this

    • logBucket

      @Stability(Stable) public DistributionProps.Builder logBucket(IBucket logBucket)
      Sets the value of DistributionProps.getLogBucket()
      Parameters:
      logBucket - The Amazon S3 bucket to store the access logs in. Make sure to set objectOwnership to s3.ObjectOwnership.OBJECT_WRITER in your custom bucket.
      Returns:
      this

    • logFilePrefix

      @Stability(Stable) public DistributionProps.Builder logFilePrefix(String logFilePrefix)
      Sets the value of DistributionProps.getLogFilePrefix()
      Parameters:
      logFilePrefix - An optional string that you want CloudFront to prefix to the access log filenames for this distribution.
      Returns:
      this

    • logIncludesCookies

      @Stability(Stable) public DistributionProps.Builder logIncludesCookies(Boolean logIncludesCookies)
      Sets the value of DistributionProps.getLogIncludesCookies()
      Parameters:
      logIncludesCookies - Specifies whether you want CloudFront to include cookies in access logs.
      Returns:
      this

    • minimumProtocolVersion

      @Stability(Stable) public DistributionProps.Builder minimumProtocolVersion(SecurityPolicyProtocol minimumProtocolVersion)
      Sets the value of DistributionProps.getMinimumProtocolVersion()
      Parameters:
      minimumProtocolVersion - 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.
      Returns:
      this

    • priceClass

      @Stability(Stable) public DistributionProps.Builder priceClass(PriceClass priceClass)
      Sets the value of DistributionProps.getPriceClass()
      Parameters:
      priceClass - 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.
      Returns:
      this

    • publishAdditionalMetrics

      @Stability(Stable) public DistributionProps.Builder publishAdditionalMetrics(Boolean publishAdditionalMetrics)
      Sets the value of DistributionProps.getPublishAdditionalMetrics()
      Parameters:
      publishAdditionalMetrics - Whether to enable additional CloudWatch metrics.
      Returns:
      this

    • sslSupportMethod

      @Stability(Stable) public DistributionProps.Builder sslSupportMethod(SSLMethod sslSupportMethod)
      Sets the value of DistributionProps.getSslSupportMethod()
      Parameters:
      sslSupportMethod - The SSL method CloudFront will use for your distribution. Server Name Indication (SNI) - is an extension to the TLS computer networking protocol by which a client indicates which hostname it is attempting to connect to at the start of the handshaking process. This allows a server to present multiple certificates on the same IP address and TCP port number and hence allows multiple secure (HTTPS) websites (or any other service over TLS) to be served by the same IP address without requiring all those sites to use the same certificate.

      CloudFront can use SNI to host multiple distributions on the same IP - which a large majority of clients will support.

      If your clients cannot support SNI however - CloudFront can use dedicated IPs for your distribution - but there is a prorated monthly charge for using this feature. By default, we use SNI - but you can optionally enable dedicated IPs (VIP).

      See the CloudFront SSL for more details about pricing : https://aws.amazon.com/cloudfront/custom-ssl-domains/

      Returns:
      this

    • webAclId

      @Stability(Stable) public DistributionProps.Builder webAclId(String webAclId)
      Sets the value of DistributionProps.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

      @Stability(Stable) public DistributionProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<DistributionProps>
      Returns:
      a new instance of DistributionProps
      Throws:
      NullPointerException - if any required attribute was not provided