Package software.amazon.awssdk.services.cloudfront.model

Interface CookiePreference.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CookiePreference.Builder,CookiePreference>, SdkBuilder<CookiePreference.Builder,CookiePreference>, SdkPojo
Enclosing class:
CookiePreference
public static interface CookiePreference.Builder extends SdkPojo, CopyableBuilder<CookiePreference.Builder,CookiePreference>

  • Method Details

    • forward

      CookiePreference.Builder forward(String forward)

      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 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.

      Parameters:
      forward - 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 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • forward

      CookiePreference.Builder forward(ItemSelection forward)

      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 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.

      Parameters:
      forward - 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 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • whitelistedNames

      CookiePreference.Builder whitelistedNames(CookieNames 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 Amazon Web Services General Reference.

      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 Amazon Web Services General Reference.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • whitelistedNames

      default CookiePreference.Builder whitelistedNames(Consumer<CookieNames.Builder> 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 Amazon Web Services General Reference.

      This is a convenience method that creates an instance of the CookieNames.Builder avoiding the need to create one manually via CookieNames.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to whitelistedNames(CookieNames).

      Parameters:
      whitelistedNames - a consumer that will call methods on CookieNames.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: