Class: Aws::CloudFront::Types::GeoRestriction

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass GeoRestriction data as a hash:

{
  restriction_type: "blacklist", # required, accepts blacklist, whitelist, none
  quantity: 1, # required
  items: ["string"],
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#itemsArray<String>

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.

Returns:

  • (Array<String>)

6381
6382
6383
6384
6385
6386
6387
# File 'lib/aws-sdk-cloudfront/types.rb', line 6381

class GeoRestriction < Struct.new(
  :restriction_type,
  :quantity,
  :items)
  SENSITIVE = []
  include Aws::Structure
end

#quantityInteger

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:

  • (Integer)

6381
6382
6383
6384
6385
6386
6387
# File 'lib/aws-sdk-cloudfront/types.rb', line 6381

class GeoRestriction < Struct.new(
  :restriction_type,
  :quantity,
  :items)
  SENSITIVE = []
  include Aws::Structure
end

#restriction_typeString

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.

Returns:

  • (String)

6381
6382
6383
6384
6385
6386
6387
# File 'lib/aws-sdk-cloudfront/types.rb', line 6381

class GeoRestriction < Struct.new(
  :restriction_type,
  :quantity,
  :items)
  SENSITIVE = []
  include Aws::Structure
end