Package software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.GeoRestrictionProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDistribution.GeoRestrictionProperty.Jsii$Proxy
Enclosing class:
CfnDistribution
@Stability(Stable) public static interface CfnDistribution.GeoRestrictionProperty extends software.amazon.jsii.JsiiSerializable
A complex type that controls the countries in which your content is distributed.

CloudFront determines the location of your users using MaxMind GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 GeoRestrictionProperty geoRestrictionProperty = GeoRestrictionProperty.builder()
         .restrictionType("restrictionType")
         // the properties below are optional
         .locations(List.of("locations"))
         .build();

  • Method Details

    • getRestrictionType

      @Stability(Stable) @NotNull String getRestrictionType()
      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.

    • getLocations

      @Stability(Stable) @Nullable default List<String> getLocations()
      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.

    • builder

      @Stability(Stable) static CfnDistribution.GeoRestrictionProperty.Builder builder()
      Returns:
      a CfnDistribution.GeoRestrictionProperty.Builder of CfnDistribution.GeoRestrictionProperty