Class GeoRestriction

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

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

See Also:

  • Method Details

    • restrictionType

      public final GeoRestrictionType restrictionType()

      The method that you want to use to restrict distribution of your content by country:

      • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

      • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

      • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

      If the service returns an enum value that is not available in the current SDK version, restrictionType will return GeoRestrictionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from restrictionTypeAsString().

      Returns:
      The method that you want to use to restrict distribution of your content by country:

      • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

      • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

      • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

      See Also:

    • restrictionTypeAsString

      public final String restrictionTypeAsString()

      The method that you want to use to restrict distribution of your content by country:

      • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

      • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

      • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

      If the service returns an enum value that is not available in the current SDK version, restrictionType will return GeoRestrictionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from restrictionTypeAsString().

      Returns:
      The method that you want to use to restrict distribution of your content by country:

      • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

      • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

      • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

      See Also:

    • quantity

      public final Integer quantity()

      When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

      Returns:
      When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

    • hasItems

      public final boolean hasItems()
      For responses, this returns true if the service returned a value for the Items property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • items

      public final List<String> items()

      A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

      The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

      CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItems() method.

      Returns:
      A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content ( blacklist).

      The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

      CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

    • toBuilder

      public GeoRestriction.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GeoRestriction.Builder,GeoRestriction>
      Returns:
      a builder for type T

    • builder

      public static GeoRestriction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GeoRestriction.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.