@aws-cdk/region-info 2.148.1 → 2.150.0

package/.jsii

@@ -31,7 +31,7 @@
   },
   "name": "@aws-cdk/region-info",
   "readme": {
-    "markdown": "# AWS Region-Specific Information Directory\n\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"
+    "markdown": "# AWS Region-Specific Information Directory\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\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 staticWebsite = regionInfo.Fact.find(\n  'ap-northeast-1',\n  regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT\n);\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.S3_STATIC_WEBSITE_ENDPOINT;\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.S3_STATIC_WEBSITE_ENDPOINT;\n  public readonly value = 'the-correct-endpoint.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",
@@ -68,25 +68,28 @@
     "@aws-cdk/region-info.Default": {
       "assembly": "@aws-cdk/region-info",
       "docs": {
-        "stability": "stable",
+        "deprecated": "- Service principals are now globally `<SERVICE>.amazonaws.com`, use iam.ServicePrincipal instead.",
+        "remarks": "This class is no longer needed because service principals are no longer needed except in very specific cases\nthat are handled in the IAM ServicePrincipal class.",
+        "stability": "deprecated",
         "summary": "Provides default values for certain regional information points."
       },
       "fqn": "@aws-cdk/region-info.Default",
       "kind": "class",
       "locationInModule": {
         "filename": "lib/default.ts",
-        "line": 4
+        "line": 7
       },
       "methods": [
         {
           "docs": {
+            "deprecated": "- Service principals are now globally `<SERVICE>.amazonaws.com`, use iam.ServicePrincipal instead.",
             "remarks": "This is useful for example when\nyou need to compute a service principal name, but you do not have a synthesize-time region literal available (so\nall you have is `{ \"Ref\": \"AWS::Region\" }`). This way you get the same defaulting behavior that is normally used\nfor built-in data.",
-            "stability": "stable",
+            "stability": "deprecated",
             "summary": "Computes a \"standard\" AWS Service principal for a given service, region and suffix."
           },
           "locationInModule": {
             "filename": "lib/default.ts",
-            "line": 23
+            "line": 30
           },
           "name": "servicePrincipal",
           "parameters": [
@@ -131,13 +134,14 @@
         {
           "const": true,
           "docs": {
-            "stability": "stable",
+            "deprecated": "- Use VpceEndpointService.DEFAULT_PREFIX instead",
+            "stability": "deprecated",
             "summary": "The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is `{ \"Ref\": \"AWS::Region\" }`)."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "lib/default.ts",
-            "line": 11
+            "line": 16
           },
           "name": "VPC_ENDPOINT_SERVICE_NAME_PREFIX",
           "static": true,
@@ -418,7 +422,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 241
+            "line": 243
           },
           "name": "adotLambdaLayer",
           "parameters": [
@@ -534,7 +538,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 252
+            "line": 254
           },
           "name": "paramsAndSecretsLambdaLayer",
           "parameters": [
@@ -566,12 +570,13 @@
         },
         {
           "docs": {
-            "stability": "stable",
+            "deprecated": "- Use `iam.ServicePrincipal.servicePrincipalName()` instead.",
+            "stability": "deprecated",
             "summary": "The name of the regional service principal for a given service."
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 230
+            "line": 232
           },
           "name": "servicePrincipal",
           "parameters": [
@@ -1042,7 +1047,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 187
+            "line": 189
           },
           "name": "adotLambdaLayerArn",
           "parameters": [
@@ -1088,7 +1093,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 161
+            "line": 163
           },
           "name": "appConfigLambdaArn",
           "parameters": [
@@ -1126,7 +1131,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 152
+            "line": 154
           },
           "name": "cloudwatchLambdaInsightsArn",
           "parameters": [
@@ -1164,7 +1169,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 197
+            "line": 199
           },
           "name": "paramsAndSecretsLambdaLayerArn",
           "parameters": [
@@ -1196,12 +1201,13 @@
         },
         {
           "docs": {
-            "stability": "stable",
+            "deprecated": "- Use `iam.ServicePrincipal.servicePrincipalName()` instead.",
+            "stability": "deprecated",
             "summary": "The name of the service principal for a given service in this region."
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 128
+            "line": 130
           },
           "name": "servicePrincipal",
           "parameters": [
@@ -1298,7 +1304,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 169
+            "line": 171
           },
           "name": "appMeshRepositoryAccount",
           "optional": true,
@@ -1314,7 +1320,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 143
+            "line": 145
           },
           "name": "dlcRepositoryAccount",
           "optional": true,
@@ -1362,7 +1368,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 135
+            "line": 137
           },
           "name": "elbv2Account",
           "optional": true,
@@ -1378,7 +1384,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 176
+            "line": 178
           },
           "name": "firehoseCidrBlock",
           "optional": true,
@@ -1442,7 +1448,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 204
+            "line": 206
           },
           "name": "samlSignOnUrl",
           "optional": true,
@@ -1470,6 +1476,6 @@
       "symbolId": "lib/region-info:RegionInfo"
     }
   },
-  "version": "2.148.1",
+  "version": "2.150.0",
   "fingerprint": "**********"
 }

package/README.md

@@ -1,6 +1,5 @@
 # AWS Region-Specific Information Directory
 
-
 ## Usage
 
 Some information used in CDK Applications differs from one AWS region to
@@ -19,7 +18,6 @@ const region = regionInfo.RegionInfo.get('eu-west-1');
 
 // Access attributes:
 region.s3StaticWebsiteEndpoint; // s3-website-eu-west-1.amazonaws.com
-region.servicePrincipal('logs.amazonaws.com'); // logs.eu-west-1.amazonaws.com
 ```
 
 The `RegionInfo` layer is built on top of the Low-Level API, which is described
@@ -34,10 +32,10 @@ a list of known fact names, which can then be used with the `RegionInfo` to
 retrieve a particular value:
 
 ```ts
-const codeDeployPrincipal = regionInfo.Fact.find('us-east-1', regionInfo.FactName.servicePrincipal('codedeploy.amazonaws.com'));
-// => codedeploy.us-east-1.amazonaws.com
-
-const staticWebsite = regionInfo.Fact.find('ap-northeast-1', regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT);
+const staticWebsite = regionInfo.Fact.find(
+  'ap-northeast-1',
+  regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT
+);
 // => s3-website-ap-northeast-1.amazonaws.com
 ```
 
@@ -50,7 +48,7 @@ to inject FactName into the database:
 ```ts
 class MyFact implements regionInfo.IFact {
   public readonly region = 'bermuda-triangle-1';
-  public readonly name = regionInfo.FactName.servicePrincipal('s3.amazonaws.com');
+  public readonly name = regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT;
   public readonly value = 's3-website.bermuda-triangle-1.nowhere.com';
 }
 
@@ -66,8 +64,8 @@ adding an extra boolean argument:
 ```ts
 class MyFact implements regionInfo.IFact {
   public readonly region = 'us-east-1';
-  public readonly name = regionInfo.FactName.servicePrincipal('service.amazonaws.com');
-  public readonly value = 'the-correct-principal.amazonaws.com';
+  public readonly name = regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT;
+  public readonly value = 'the-correct-endpoint.amazonaws.com';
 }
 
 regionInfo.Fact.register(new MyFact(), true /* Allow overriding information */);