Amazonka.CloudFront.Types.GeoRestriction

Documentation

data 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: newGeoRestriction smart constructor.

Constructors

GeoRestriction'

Fields

• items :: Maybe [Text]

  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.

• restrictionType :: GeoRestrictionType

  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.
• quantity :: Int

  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.

Instances

FromXML GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Methods

parseXML :: [Node] -> Either String GeoRestriction

ToXML GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Methods

toXML :: GeoRestriction -> XML

Generic GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Associated Types

type Rep GeoRestriction :: Type -> Type

Methods

from :: GeoRestriction -> Rep GeoRestriction x

to :: Rep GeoRestriction x -> GeoRestriction

Read GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Methods

readsPrec :: Int -> ReadS GeoRestriction

readList :: ReadS [GeoRestriction]

readPrec :: ReadPrec GeoRestriction

readListPrec :: ReadPrec [GeoRestriction]

Show GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Methods

showsPrec :: Int -> GeoRestriction -> ShowS

show :: GeoRestriction -> String

showList :: [GeoRestriction] -> ShowS

NFData GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Methods

rnf :: GeoRestriction -> ()

Eq GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Methods

(==) :: GeoRestriction -> GeoRestriction -> Bool

(/=) :: GeoRestriction -> GeoRestriction -> Bool

Hashable GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

Methods

hashWithSalt :: Int -> GeoRestriction -> Int

hash :: GeoRestriction -> Int

type Rep GeoRestriction

Defined in Amazonka.CloudFront.Types.GeoRestriction

type Rep GeoRestriction = D1 ('MetaData "GeoRestriction" "Amazonka.CloudFront.Types.GeoRestriction" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "GeoRestriction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "restrictionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeoRestrictionType) :*: S1 ('MetaSel ('Just "quantity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGeoRestriction

Arguments

:: GeoRestrictionType

$sel:restrictionType:GeoRestriction'

-> Int

$sel:quantity:GeoRestriction'

-> GeoRestriction

Create a value of GeoRestriction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:items:GeoRestriction', geoRestriction_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.

$sel:restrictionType:GeoRestriction', geoRestriction_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.

$sel:quantity:GeoRestriction', geoRestriction_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.

geoRestriction_items :: Lens' GeoRestriction (Maybe [Text])

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.

geoRestriction_restrictionType :: Lens' GeoRestriction GeoRestrictionType

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.

geoRestriction_quantity :: Lens' GeoRestriction Int

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.