Package software.amazon.awscdk.services.cloudfront

Class OriginOptions.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • connectionAttempts

      @Stability(Stable) public OriginOptions.Builder connectionAttempts(Number connectionAttempts)
      Sets the value of OriginOptions.getConnectionAttempts()
      Parameters:
      connectionAttempts - The number of times that CloudFront attempts to connect to the origin;. valid values are 1, 2, or 3 attempts.
      Returns:
      this

    • connectionTimeout

      @Stability(Stable) public OriginOptions.Builder connectionTimeout(Duration connectionTimeout)
      Sets the value of OriginOptions.getConnectionTimeout()
      Parameters:
      connectionTimeout - The number of seconds that CloudFront waits when trying to establish a connection to the origin. Valid values are 1-10 seconds, inclusive.
      Returns:
      this

    • customHeaders

      @Stability(Stable) public OriginOptions.Builder customHeaders(Map<String,String> customHeaders)
      Sets the value of OriginOptions.getCustomHeaders()
      Parameters:
      customHeaders - A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
      Returns:
      this

    • originAccessControlId

      @Stability(Stable) public OriginOptions.Builder originAccessControlId(String originAccessControlId)
      Sets the value of OriginOptions.getOriginAccessControlId()
      Parameters:
      originAccessControlId - The unique identifier of an origin access control for this origin.
      Returns:
      this

    • originId

      @Stability(Stable) public OriginOptions.Builder originId(String originId)
      Sets the value of OriginOptions.getOriginId()
      Parameters:
      originId - A unique identifier for the origin. This value must be unique within the distribution.
      Returns:
      this

    • originShieldEnabled

      @Stability(Stable) public OriginOptions.Builder originShieldEnabled(Boolean originShieldEnabled)
      Sets the value of OriginOptions.getOriginShieldEnabled()
      Parameters:
      originShieldEnabled - Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.
      Returns:
      this

    • originShieldRegion

      @Stability(Stable) public OriginOptions.Builder originShieldRegion(String originShieldRegion)
      Sets the value of OriginOptions.getOriginShieldRegion()
      Parameters:
      originShieldRegion - When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
      Returns:
      this

    • responseCompletionTimeout

      @Stability(Stable) public OriginOptions.Builder responseCompletionTimeout(Duration responseCompletionTimeout)
      Sets the value of OriginOptions.getResponseCompletionTimeout()
      Parameters:
      responseCompletionTimeout - The time that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.

      Valid values are 1-3600 seconds, inclusive.

      Returns:
      this

    • build

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