You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudfront/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.

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>)


3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3391

class GeoRestriction < Struct.new(
  :restriction_type,
  :quantity,
  :items)
  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)


3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3391

class GeoRestriction < Struct.new(
  :restriction_type,
  :quantity,
  :items)
  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)


3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3391

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