Skip to main content

AWS region information, such as service principal names

Project description

AWS Region-Specific Information Directory

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":
region = region_info.RegionInfo.get("eu-west-1")

# Access attributes:
region.s3_static_website_endpoint

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:

static_website = region_info.Fact.find("ap-northeast-1", region_info.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:

@jsii.implements(region_info.IFact)
class MyFact:

region_info.Fact.register(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:

@jsii.implements(region_info.IFact)
class MyFact:

region_info.Fact.register(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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws_cdk_region_info-2.204.0.tar.gz (293.6 kB view details)

Uploaded Source

Built Distribution

aws_cdk_region_info-2.204.0-py3-none-any.whl (292.3 kB view details)

Uploaded Python 3

File details

Details for the file aws_cdk_region_info-2.204.0.tar.gz.

File metadata

  • Download URL: aws_cdk_region_info-2.204.0.tar.gz
  • Upload date:
  • Size: 293.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for aws_cdk_region_info-2.204.0.tar.gz
Algorithm Hash digest
SHA256 91603f4ce0aa81726695c08aeecdd6f700195df2205d9ce579c852a59d8506ce
MD5 9cb32411801e5fcf013f6062b13519cb
BLAKE2b-256 e6d53bfad3a9648cb6412d27487464240b348f410c619c993ab848dfbecb3617

See more details on using hashes here.

File details

Details for the file aws_cdk_region_info-2.204.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_cdk_region_info-2.204.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75a0464572ebc116c26143f9ab370696b64fe865ae2e5be26a95b8c9be3f58f9
MD5 b1d1917acee27fdcc767b1cd17b4aaa4
BLAKE2b-256 3024250f3b20720457a1d7ad7a833df6f6732898459cf521e30387a5383f360c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page