Class: AWSCDK::CloudFront::CfnDistribution::GeoRestrictionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CloudFront::CfnDistribution::GeoRestrictionProperty

Defined in:

cloud_front/cfn_distribution.rb

Overview

A complex type that controls the countries in which your content is distributed.

CloudFront determines the location of your users using MaxMind GeoIP databases. To disable geo restriction, remove the Restrictions property from your stack template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html

Instance Attribute Summary

• #locations ⇒ Array<String>^? readonly

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

• #restriction_type ⇒ String readonly

  The method that you want to use to restrict distribution of your content by country:.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(restriction_type:, locations: nil) ⇒ GeoRestrictionProperty constructor

  A new instance of GeoRestrictionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(restriction_type:, locations: nil) ⇒ GeoRestrictionProperty

Returns a new instance of GeoRestrictionProperty.

Parameters:

• restriction_type (String) —

  The method that you want to use to restrict distribution of your content by country:.

• locations (Array<String>, nil) (defaults to: nil) —

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

# File 'cloud_front/cfn_distribution.rb', line 2150

def initialize(restriction_type:, locations: nil)
  @restriction_type = restriction_type
  Jsii::Type.check_type(@restriction_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restrictionType")
  @locations = locations
  Jsii::Type.check_type(@locations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "locations") unless @locations.nil?
end

Instance Attribute Details

#locations ⇒ Array<String>^? (readonly)

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-locations

# File 'cloud_front/cfn_distribution.rb', line 2174

def locations
  @locations
end

#restriction_type ⇒ String (readonly)

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)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-restrictiontype

# File 'cloud_front/cfn_distribution.rb', line 2165

def restriction_type
  @restriction_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cloud_front/cfn_distribution.rb', line 2176

def self.jsii_properties
  {
    :restriction_type => "restrictionType",
    :locations => "locations",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cloud_front/cfn_distribution.rb', line 2183

def to_jsii
  result = {}
  result.merge!({
    "restrictionType" => @restriction_type,
    "locations" => @locations,
  })
  result.compact
end