Skip to main content

Restrictions

Available through: CLI, Python SDK, Rust SDK, API

This document describes how to set restrictions on providers or regions used by the Seaplane Global Coordination Services (Coordination APIs) including the Metadata Key-Value Store (Metadata KVS) and Locks.

By default, the Coordination APIs store data globally, across providers, for the best end-user performance. With the restriction API, you can override the default behavior and restrict the use of locations or providers. For the best performance, we recommended using restrictions only when absolutely necessary for regulatory purposes (GDPR compliance, for example).

Note that having too many restrictions can impact performance. For example:

  • Data restricted to a single country could increase latency for users across the globe.
  • Data restricted to a single cloud provider could become unavailable when that provider suffers an outage.

Restrictions are applied to a directory and are specific to an API. For example, restrictions set to a directory called /prod/ in the Metadata KVS do not affect any directory within the Locks service.

Restrictions can exist without the affected directory existing i.e., you can set up restrictions before creating your directories. For example, you can create a restriction on the eu directory to limit the geographic location of the data in eu to the European Union. Creating the directory and adding a key automatically applies the predefined restrictions. Similarly, deleting a directory does not remove a restriction.

For more information and code examples, see the restrictions API docs.

Restriction State

The restriction state indicates if a restriction is pending or enforced. Introducing a new restriction takes some time as the data moves to comply with the new rule. During this time, the restriction is pending. Once completed, the restriction state is enforced.

Supported Regions

2-letter codeFull Name
AEUnited Arab Emirates
AUAustralia
BEBelgium
BHBahrain
BRBrazil
CACanada
CHSwitzerland
CLChile
DEGermany
ESSpain
FIFinland
FRFrance
GBUnited Kingdom of Great Britain and Northern Ireland
HKHong Kong
IDIndonesia
IERepublic of Ireland
INIndia
ITItaly
JPJapan
KRKorea, Republic of
NLNetherlands
PLPoland
RORomania
SESweden
SGSingapore
TWTaiwan
USUnited States of America
ZASouth Africa
In addtion to countries the following grouped geo-regions are available
XAAsia
XCPeople's Republic of China
XEEurope
XFAfrica
XNNorth America
XOOceania
XQAntartica
XSSouth America
XUThe UK

Supported Providers

Full NameAlias
Amazon Web Servicesaws
Microsoft Azureazure
Digtial Oceandigitalocean
Equinixequinix
Google Cloud Platformgcp