Package software.amazon.awscdk.services.cloudfront

Class CfnDistribution.CookiesProperty.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • forward

      @Stability(Stable) public CfnDistribution.CookiesProperty.Builder forward(String forward)
      Sets the value of CfnDistribution.CookiesProperty.getForward()
      Parameters:
      forward - This field is deprecated. This parameter is required. We recommend that you use a cache policy or an origin request policy instead of this field.

      If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .

      If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .

      Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

      Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

      Returns:
      this

    • whitelistedNames

      @Stability(Stable) public CfnDistribution.CookiesProperty.Builder whitelistedNames(List<String> whitelistedNames)
      Sets the value of CfnDistribution.CookiesProperty.getWhitelistedNames()
      Parameters:
      whitelistedNames - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

      If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide .

      If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide .

      Required if you specify whitelist for the value of Forward . A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

      If you specify all or none for the value of Forward , omit WhitelistedNames . If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

      For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference .

      Returns:
      this

    • build

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