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

Class CacheTagConfig

java.lang.Object
software.amazon.awssdk.services.cloudfront.model.CacheTagConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CacheTagConfig.Builder,CacheTagConfig>
@Generated("software.amazon.awssdk:codegen") public final class CacheTagConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CacheTagConfig.Builder,CacheTagConfig>

A complex type that specifies the HTTP header name from which CloudFront extracts cache tags from origin responses. When you add CacheTagConfig to a distribution, CloudFront reads the specified header from origin responses, parses the comma-separated tag values, and stores them with the cached object. You can then invalidate cached objects by tag using the CreateInvalidation API.

See Also:

  • Method Details

    • headerName

      public final String headerName()

      The name of the HTTP header that your origin includes in responses. CloudFront uses this header to extract cache tags. The header value must contain comma-separated tag values (for example, product:electronics, category:tv, brand:example).

      Returns:
      The name of the HTTP header that your origin includes in responses. CloudFront uses this header to extract cache tags. The header value must contain comma-separated tag values (for example, product:electronics, category:tv, brand:example).

    • toBuilder

      public CacheTagConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CacheTagConfig.Builder,CacheTagConfig>

    • builder

      public static CacheTagConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CacheTagConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo