Sol Concer

Home / updates

AWS SDK for C++: Aws::CloudFront::Model::GeoRestriction Class Reference

William Smith |

#include <GeoRestriction.h>

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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:

AWS API Reference

Definition at line 34 of file GeoRestriction.h.

◆ GeoRestriction() [1/2]

AWS_CLOUDFRONT_API Aws::CloudFront::Model::GeoRestriction::GeoRestriction ( )

◆ GeoRestriction() [2/2]

◆ AddItems() [1/3]

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.

Definition at line 276 of file GeoRestriction.h.

◆ AddItems() [2/3]

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.

Definition at line 260 of file GeoRestriction.h.

◆ AddItems() [3/3] GeoRestriction & Aws::CloudFront::Model::GeoRestriction::AddItems ( const char *  value) inline

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.

Definition at line 292 of file GeoRestriction.h.

◆ AddToNode() AWS_CLOUDFRONT_API void Aws::CloudFront::Model::GeoRestriction::AddToNode ( Aws::Utils::Xml::XmlNode &  parentNode) const

◆ GetItems()

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.

Definition at line 164 of file GeoRestriction.h.

◆ GetQuantity()

int Aws::CloudFront::Model::GeoRestriction::GetQuantity ( ) const

inline

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.

Definition at line 123 of file GeoRestriction.h.

◆ GetRestrictionType() const GeoRestrictionType & Aws::CloudFront::Model::GeoRestriction::GetRestrictionType ( ) const inline

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.

Definition at line 54 of file GeoRestriction.h.

◆ ItemsHasBeenSet()

bool Aws::CloudFront::Model::GeoRestriction::ItemsHasBeenSet ( ) const

inline

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.

Definition at line 180 of file GeoRestriction.h.

◆ operator=()

◆ QuantityHasBeenSet()

bool Aws::CloudFront::Model::GeoRestriction::QuantityHasBeenSet ( ) const

inline

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.

Definition at line 131 of file GeoRestriction.h.

◆ RestrictionTypeHasBeenSet()

bool Aws::CloudFront::Model::GeoRestriction::RestrictionTypeHasBeenSet ( ) const

inline

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.

Definition at line 66 of file GeoRestriction.h.

◆ SetItems() [1/2]

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.

Definition at line 212 of file GeoRestriction.h.

◆ SetItems() [2/2]

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.

Definition at line 196 of file GeoRestriction.h.

◆ SetQuantity()

void Aws::CloudFront::Model::GeoRestriction::SetQuantity ( int  value)

inline

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.

Definition at line 139 of file GeoRestriction.h.

◆ SetRestrictionType() [1/2] void Aws::CloudFront::Model::GeoRestriction::SetRestrictionType ( const GeoRestrictionType &  value) inline

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.

Definition at line 78 of file GeoRestriction.h.

◆ SetRestrictionType() [2/2] void Aws::CloudFront::Model::GeoRestriction::SetRestrictionType ( GeoRestrictionType &&  value) inline

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.

Definition at line 90 of file GeoRestriction.h.

◆ WithItems() [1/2]

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.

Definition at line 244 of file GeoRestriction.h.

◆ WithItems() [2/2]

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.

Definition at line 228 of file GeoRestriction.h.

◆ WithQuantity() GeoRestriction & Aws::CloudFront::Model::GeoRestriction::WithQuantity ( int  value) inline

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.

Definition at line 147 of file GeoRestriction.h.

◆ WithRestrictionType() [1/2]

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.

Definition at line 102 of file GeoRestriction.h.

◆ WithRestrictionType() [2/2]

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.

Definition at line 114 of file GeoRestriction.h.

The documentation for this class was generated from the following file:
  • generated/src/aws-cpp-sdk-cloudfront/include/aws/cloudfront/model/GeoRestriction.h

You Might Also Like