Struct GeoRestriction

#[non_exhaustive]
pub struct GeoRestriction {
    pub restriction_type: GeoRestrictionType,
    pub quantity: i32,
    pub items: Option<Vec<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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

restriction_type: 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: i32

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.

items: Option<Vec<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.

Implementations

impl GeoRestriction

pub fn restriction_type(&self) -> &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.

pub fn quantity(&self) -> i32

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.

pub fn items(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .items.is_none().

impl GeoRestriction

pub fn builder() -> GeoRestrictionBuilder

Creates a new builder-style object to manufacture GeoRestriction.

Trait Implementations

impl Clone for GeoRestriction

fn clone(&self) -> GeoRestriction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GeoRestriction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GeoRestriction

fn eq(&self, other: &GeoRestriction) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GeoRestriction