AWS Region-Specific Information Directory

---

End-of-Support

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.

Usage

Some information used in CDK Applications differs from one AWS region to another, such as service principals used in IAM policies, S3 static website endpoints, ...

The `RegionInfo` class

The library offers a simple interface to obtain region specific information in the form of the RegionInfo class. This is the preferred way to interact with the regional information database:

 // Get the information for "eu-west-1":
 RegionInfo region = RegionInfo.get("eu-west-1");
 
 // Access attributes:
 region.getS3StaticWebsiteEndpoint(); // s3-website-eu-west-1.amazonaws.com
 region.servicePrincipal("logs.amazonaws.com");

The RegionInfo layer is built on top of the Low-Level API, which is described below and can be used to register additional data, including user-defined facts that are not available through the RegionInfo interface.

Low-Level API

This library offers a primitive database of such information so that CDK constructs can easily access regional information. The FactName class provides a list of known fact names, which can then be used with the RegionInfo to retrieve a particular value:

 String codeDeployPrincipal = Fact.find("us-east-1", FactName.servicePrincipal("codedeploy.amazonaws.com"));
 // => codedeploy.us-east-1.amazonaws.com
 
 String staticWebsite = Fact.find("ap-northeast-1", FactName.S3_STATIC_WEBSITE_ENDPOINT);

Supplying new or missing information

As new regions are released, it might happen that a particular fact you need is missing from the library. In such cases, the Fact.register method can be used to inject FactName into the database:

 public class MyFact implements IFact {
     public final Object region;
     public final Object name;
     public final Object value;
 }
 
 Fact.register(new MyFact());

Overriding incorrect information

In the event information provided by the library is incorrect, it can be overridden using the same Fact.register method demonstrated above, simply adding an extra boolean argument:

 public class MyFact implements IFact {
     public final Object region;
     public final Object name;
     public final Object value;
 }
 
 Fact.register(new MyFact(), true);

If you happen to have stumbled upon incorrect data built into this library, it is always a good idea to report your findings in a GitHub issue, so we can fix it for everyone else!

This module is part of the AWS Cloud Development Kit project. Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html

Class

Description

$Module

Default

Provides default values for certain regional information points.

Fact

A database of regional information.

FactName

All standardized fact names.

IFact

A fact that can be registered about a particular region.

IFact.Jsii$Default

Internal default implementation for IFact.

IFact.Jsii$Proxy

A proxy class which represents a concrete javascript instance of this type.

RegionInfo

Information pertaining to an AWS region.