Package software.amazon.awscdk.services.cloudfront

Class CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • cookiesConfig

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder cookiesConfig(IResolvable cookiesConfig)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getCookiesConfig()
      Parameters:
      cookiesConfig - An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. This parameter is required.
      Returns:
      this

    • cookiesConfig

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder cookiesConfig(CfnCachePolicy.CookiesConfigProperty cookiesConfig)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getCookiesConfig()
      Parameters:
      cookiesConfig - An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. This parameter is required.
      Returns:
      this

    • enableAcceptEncodingGzip

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingGzip(Boolean enableAcceptEncodingGzip)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingGzip()
      Parameters:
      enableAcceptEncodingGzip - A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This parameter is required. This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

      • Normalizes the value of the viewer's Accept-Encoding header
      • Includes the normalized header in the cache key
      • Includes the normalized header in the request to the origin, if a request is necessary

      For more information, see Compression support in the Amazon CloudFront Developer Guide .

      If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

      If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

      Returns:
      this

    • enableAcceptEncodingGzip

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingGzip(IResolvable enableAcceptEncodingGzip)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingGzip()
      Parameters:
      enableAcceptEncodingGzip - A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This parameter is required. This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

      • Normalizes the value of the viewer's Accept-Encoding header
      • Includes the normalized header in the cache key
      • Includes the normalized header in the request to the origin, if a request is necessary

      For more information, see Compression support in the Amazon CloudFront Developer Guide .

      If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

      If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

      Returns:
      this

    • headersConfig

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder headersConfig(IResolvable headersConfig)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getHeadersConfig()
      Parameters:
      headersConfig - An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin. This parameter is required.
      Returns:
      this

    • headersConfig

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder headersConfig(CfnCachePolicy.HeadersConfigProperty headersConfig)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getHeadersConfig()
      Parameters:
      headersConfig - An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin. This parameter is required.
      Returns:
      this

    • queryStringsConfig

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder queryStringsConfig(IResolvable queryStringsConfig)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getQueryStringsConfig()
      Parameters:
      queryStringsConfig - An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin. This parameter is required.
      Returns:
      this

    • queryStringsConfig

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder queryStringsConfig(CfnCachePolicy.QueryStringsConfigProperty queryStringsConfig)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getQueryStringsConfig()
      Parameters:
      queryStringsConfig - An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin. This parameter is required.
      Returns:
      this

    • enableAcceptEncodingBrotli

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingBrotli(Boolean enableAcceptEncodingBrotli)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingBrotli()
      Parameters:
      enableAcceptEncodingBrotli - A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

      • Normalizes the value of the viewer's Accept-Encoding header
      • Includes the normalized header in the cache key
      • Includes the normalized header in the request to the origin, if a request is necessary

      For more information, see Compression support in the Amazon CloudFront Developer Guide .

      If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

      If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

      Returns:
      this

    • enableAcceptEncodingBrotli

      @Stability(Stable) public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingBrotli(IResolvable enableAcceptEncodingBrotli)
      Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingBrotli()
      Parameters:
      enableAcceptEncodingBrotli - A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

      • Normalizes the value of the viewer's Accept-Encoding header
      • Includes the normalized header in the cache key
      • Includes the normalized header in the request to the origin, if a request is necessary

      For more information, see Compression support in the Amazon CloudFront Developer Guide .

      If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

      If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

      Returns:
      this

    • build

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