@aws-cdk/region-info 2.9.0 → 2.10.0

package/.jsii

@@ -23,12 +23,15 @@
       "compiledWithDeprecationWarnings": true,
       "pacmak": {
         "hasDefaultInterfaces": true
+      },
+      "rosetta": {
+        "strict": true
       }
     }
   },
   "name": "@aws-cdk/region-info",
   "readme": {
-    "markdown": "# AWS Region-Specific Information Directory\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n<!--END STABILITY BANNER-->\n\n## Usage\n\nSome information used in CDK Applications differs from one AWS region to\nanother, such as service principals used in IAM policies, S3 static website\nendpoints, ...\n\n### The `RegionInfo` class\n\nThe library offers a simple interface to obtain region specific information in\nthe form of the `RegionInfo` class. This is the preferred way to interact with\nthe regional information database:\n\n```ts\nimport { RegionInfo } from '@aws-cdk/region-info';\n\n// Get the information for \"eu-west-1\":\nconst region = RegionInfo.get('eu-west-1');\n\n// Access attributes:\nregion.s3StaticWebsiteEndpoint; // s3-website-eu-west-1.amazonaws.com\nregion.servicePrincipal('logs.amazonaws.com'); // logs.eu-west-1.amazonaws.com\n```\n\nThe `RegionInfo` layer is built on top of the Low-Level API, which is described\nbelow and can be used to register additional data, including user-defined facts\nthat are not available through the `RegionInfo` interface.\n\n### Low-Level API\n\nThis library offers a primitive database of such information so that CDK\nconstructs can easily access regional information. The `FactName` class provides\na list of known fact names, which can then be used with the `RegionInfo` to\nretrieve a particular value:\n\n```ts\nimport * as regionInfo from '@aws-cdk/region-info';\n\nconst codeDeployPrincipal = regionInfo.Fact.find('us-east-1', regionInfo.FactName.servicePrincipal('codedeploy.amazonaws.com'));\n// => codedeploy.us-east-1.amazonaws.com\n\nconst staticWebsite = regionInfo.Fact.find('ap-northeast-1', regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT);\n// => s3-website-ap-northeast-1.amazonaws.com\n```\n\n## Supplying new or missing information\n\nAs new regions are released, it might happen that a particular fact you need is\nmissing from the library. In such cases, the `Fact.register` method can be used\nto inject FactName into the database:\n\n```ts\nregionInfo.Fact.register({\n  region: 'bermuda-triangle-1',\n  name: regionInfo.FactName.servicePrincipal('s3.amazonaws.com'),\n  value: 's3-website.bermuda-triangle-1.nowhere.com',\n});\n```\n\n## Overriding incorrect information\n\nIn the event information provided by the library is incorrect, it can be\noverridden using the same `Fact.register` method demonstrated above, simply\nadding an extra boolean argument:\n\n```ts\nregionInfo.Fact.register({\n  region: 'us-east-1',\n  name: regionInfo.FactName.servicePrincipal('service.amazonaws.com'),\n  value: 'the-correct-principal.amazonaws.com',\n}, true /* Allow overriding information */);\n```\n\nIf you happen to have stumbled upon incorrect data built into this library, it\nis always a good idea to report your findings in a [GitHub issue], so we can fix\nit for everyone else!\n\n[GitHub issue]: https://github.com/aws/aws-cdk/issues\n\n---\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n"
+    "markdown": "# AWS Region-Specific Information Directory\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n<!--END STABILITY BANNER-->\n\n## Usage\n\nSome information used in CDK Applications differs from one AWS region to\nanother, such as service principals used in IAM policies, S3 static website\nendpoints, ...\n\n### The `RegionInfo` class\n\nThe library offers a simple interface to obtain region specific information in\nthe form of the `RegionInfo` class. This is the preferred way to interact with\nthe regional information database:\n\n```ts\n// Get the information for \"eu-west-1\":\nconst region = regionInfo.RegionInfo.get('eu-west-1');\n\n// Access attributes:\nregion.s3StaticWebsiteEndpoint; // s3-website-eu-west-1.amazonaws.com\nregion.servicePrincipal('logs.amazonaws.com'); // logs.eu-west-1.amazonaws.com\n```\n\nThe `RegionInfo` layer is built on top of the Low-Level API, which is described\nbelow and can be used to register additional data, including user-defined facts\nthat are not available through the `RegionInfo` interface.\n\n### Low-Level API\n\nThis library offers a primitive database of such information so that CDK\nconstructs can easily access regional information. The `FactName` class provides\na list of known fact names, which can then be used with the `RegionInfo` to\nretrieve a particular value:\n\n```ts\nconst codeDeployPrincipal = regionInfo.Fact.find('us-east-1', regionInfo.FactName.servicePrincipal('codedeploy.amazonaws.com'));\n// => codedeploy.us-east-1.amazonaws.com\n\nconst staticWebsite = regionInfo.Fact.find('ap-northeast-1', regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT);\n// => s3-website-ap-northeast-1.amazonaws.com\n```\n\n## Supplying new or missing information\n\nAs new regions are released, it might happen that a particular fact you need is\nmissing from the library. In such cases, the `Fact.register` method can be used\nto inject FactName into the database:\n\n```ts\nclass MyFact implements regionInfo.IFact {\n  public readonly region = 'bermuda-triangle-1';\n  public readonly name = regionInfo.FactName.servicePrincipal('s3.amazonaws.com');\n  public readonly value = 's3-website.bermuda-triangle-1.nowhere.com';\n}\n\nregionInfo.Fact.register(new MyFact());\n```\n\n## Overriding incorrect information\n\nIn the event information provided by the library is incorrect, it can be\noverridden using the same `Fact.register` method demonstrated above, simply\nadding an extra boolean argument:\n\n```ts\nclass MyFact implements regionInfo.IFact {\n  public readonly region = 'us-east-1';\n  public readonly name = regionInfo.FactName.servicePrincipal('service.amazonaws.com');\n  public readonly value = 'the-correct-principal.amazonaws.com';\n}\n\nregionInfo.Fact.register(new MyFact(), true /* Allow overriding information */);\n```\n\nIf you happen to have stumbled upon incorrect data built into this library, it\nis always a good idea to report your findings in a [GitHub issue], so we can fix\nit for everyone else!\n\n[GitHub issue]: https://github.com/aws/aws-cdk/issues\n\n---\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n"
   },
   "repository": {
     "directory": "packages/@aws-cdk/region-info",
@@ -151,7 +154,7 @@
         "custom": {
           "exampleMetadata": "infused"
         },
-        "example": "import * as regionInfo from '@aws-cdk/region-info';\n\nconst codeDeployPrincipal = regionInfo.Fact.find('us-east-1', regionInfo.FactName.servicePrincipal('codedeploy.amazonaws.com'));\n// => codedeploy.us-east-1.amazonaws.com\n\nconst staticWebsite = regionInfo.Fact.find('ap-northeast-1', regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT);\n// => s3-website-ap-northeast-1.amazonaws.com",
+        "example": "class MyFact implements regionInfo.IFact {\n  public readonly region = 'bermuda-triangle-1';\n  public readonly name = regionInfo.FactName.servicePrincipal('s3.amazonaws.com');\n  public readonly value = 's3-website.bermuda-triangle-1.nowhere.com';\n}\n\nregionInfo.Fact.register(new MyFact());",
         "stability": "stable",
         "summary": "A database of regional information."
       },
@@ -170,7 +173,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 23
+            "line": 24
           },
           "name": "find",
           "parameters": [
@@ -208,7 +211,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 51
+            "line": 52
           },
           "name": "register",
           "parameters": [
@@ -242,7 +245,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 35
+            "line": 36
           },
           "name": "requireFact",
           "parameters": [
@@ -279,7 +282,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 68
+            "line": 69
           },
           "name": "unregister",
           "parameters": [
@@ -347,7 +350,7 @@
         "custom": {
           "exampleMetadata": "infused"
         },
-        "example": "import * as regionInfo from '@aws-cdk/region-info';\n\nconst codeDeployPrincipal = regionInfo.Fact.find('us-east-1', regionInfo.FactName.servicePrincipal('codedeploy.amazonaws.com'));\n// => codedeploy.us-east-1.amazonaws.com\n\nconst staticWebsite = regionInfo.Fact.find('ap-northeast-1', regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT);\n// => s3-website-ap-northeast-1.amazonaws.com",
+        "example": "class MyFact implements regionInfo.IFact {\n  public readonly region = 'bermuda-triangle-1';\n  public readonly name = regionInfo.FactName.servicePrincipal('s3.amazonaws.com');\n  public readonly value = 's3-website.bermuda-triangle-1.nowhere.com';\n}\n\nregionInfo.Fact.register(new MyFact());",
         "stability": "stable",
         "summary": "All standardized fact names."
       },
@@ -360,7 +363,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/fact.ts",
-        "line": 106
+        "line": 107
       },
       "methods": [
         {
@@ -370,7 +373,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 170
+            "line": 171
           },
           "name": "cloudwatchLambdaInsightsVersion",
           "parameters": [
@@ -402,7 +405,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 184
+            "line": 185
           },
           "name": "servicePrincipal",
           "parameters": [
@@ -435,7 +438,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 160
+            "line": 161
           },
           "name": "APPMESH_ECR_ACCOUNT",
           "static": true,
@@ -453,7 +456,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 121
+            "line": 122
           },
           "name": "CDK_METADATA_RESOURCE_AVAILABLE",
           "static": true,
@@ -470,7 +473,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 154
+            "line": 155
           },
           "name": "DLC_REPOSITORY_ACCOUNT",
           "static": true,
@@ -487,7 +490,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 115
+            "line": 116
           },
           "name": "DOMAIN_SUFFIX",
           "static": true,
@@ -504,7 +507,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 136
+            "line": 137
           },
           "name": "EBS_ENV_ENDPOINT_HOSTED_ZONE_ID",
           "static": true,
@@ -521,7 +524,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 148
+            "line": 149
           },
           "name": "ELBV2_ACCOUNT",
           "static": true,
@@ -538,7 +541,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 165
+            "line": 166
           },
           "name": "FIREHOSE_CIDR_BLOCK",
           "static": true,
@@ -555,7 +558,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 110
+            "line": 111
           },
           "name": "PARTITION",
           "static": true,
@@ -572,7 +575,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 126
+            "line": 127
           },
           "name": "S3_STATIC_WEBSITE_ENDPOINT",
           "static": true,
@@ -589,7 +592,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 131
+            "line": 132
           },
           "name": "S3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_ID",
           "static": true,
@@ -606,7 +609,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 143
+            "line": 144
           },
           "name": "VPC_ENDPOINT_SERVICE_NAME_PREFIX",
           "static": true,
@@ -627,7 +630,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/fact.ts",
-        "line": 86
+        "line": 87
       },
       "name": "IFact",
       "properties": [
@@ -641,7 +644,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 95
+            "line": 96
           },
           "name": "name",
           "type": {
@@ -657,7 +660,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 90
+            "line": 91
           },
           "name": "region",
           "type": {
@@ -673,7 +676,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 100
+            "line": 101
           },
           "name": "value",
           "optional": true,
@@ -690,7 +693,7 @@
         "custom": {
           "exampleMetadata": "infused"
         },
-        "example": "import { RegionInfo } from '@aws-cdk/region-info';\n\n// Get the information for \"eu-west-1\":\nconst region = RegionInfo.get('eu-west-1');\n\n// Access attributes:\nregion.s3StaticWebsiteEndpoint; // s3-website-eu-west-1.amazonaws.com\nregion.servicePrincipal('logs.amazonaws.com'); // logs.eu-west-1.amazonaws.com",
+        "example": "// Get the information for \"eu-west-1\":\nconst region = regionInfo.RegionInfo.get('eu-west-1');\n\n// Access attributes:\nregion.s3StaticWebsiteEndpoint; // s3-website-eu-west-1.amazonaws.com\nregion.servicePrincipal('logs.amazonaws.com'); // logs.eu-west-1.amazonaws.com",
         "stability": "stable",
         "summary": "Information pertaining to an AWS region."
       },
@@ -1097,6 +1100,6 @@
       "symbolId": "lib/region-info:RegionInfo"
     }
   },
-  "version": "2.9.0",
+  "version": "2.10.0",
   "fingerprint": "**********"
 }