1.204.0

interface GeoRestrictionProperty

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.CfnDistribution.GeoRestrictionProperty
Javasoftware.amazon.awscdk.services.cloudfront.CfnDistribution.GeoRestrictionProperty
Pythonaws_cdk.aws_cloudfront.CfnDistribution.GeoRestrictionProperty
TypeScript @aws-cdk/aws-cloudfront » CfnDistribution » GeoRestrictionProperty

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudfront from '@aws-cdk/aws-cloudfront';
const geoRestrictionProperty: cloudfront.CfnDistribution.GeoRestrictionProperty = {
  restrictionType: 'restrictionType',

  // the properties below are optional
  locations: ['locations'],
};

Properties

NameTypeDescription
restrictionTypestringThe method that you want to use to restrict distribution of your content by country:.
locations?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 ).

restrictionType

Type: string

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.

locations?

Type: string[] (optional)

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.

← PreviousNext →