@aws-cdk/region-info 2.1.0 → 2.5.0

package/.jsii

@@ -12,7 +12,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/aws/aws-cdk",
-  "jsiiVersion": "1.46.0 (build cd08c55)",
+  "jsiiVersion": "1.50.0 (build d1830a4)",
   "keywords": [
     "aws",
     "cdk"
@@ -72,7 +72,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/default.ts",
-        "line": 4
+        "line": 6
       },
       "methods": [
         {
@@ -83,7 +83,7 @@
           },
           "locationInModule": {
             "filename": "lib/default.ts",
-            "line": 23
+            "line": 25
           },
           "name": "servicePrincipal",
           "parameters": [
@@ -91,7 +91,7 @@
               "docs": {
                 "summary": "the name of the service (s3, s3.amazonaws.com, ...)."
               },
-              "name": "service",
+              "name": "serviceFqn",
               "type": {
                 "primitive": "string"
               }
@@ -107,7 +107,7 @@
             },
             {
               "docs": {
-                "summary": "the URL suffix for the partition in which the region is located."
+                "summary": "deprecated and ignored."
               },
               "name": "urlSuffix",
               "type": {
@@ -134,7 +134,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/default.ts",
-            "line": 11
+            "line": 13
           },
           "name": "VPC_ENDPOINT_SERVICE_NAME_PREFIX",
           "static": true,
@@ -148,6 +148,9 @@
     "@aws-cdk/region-info.Fact": {
       "assembly": "@aws-cdk/region-info",
       "docs": {
+        "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",
         "stability": "stable",
         "summary": "A database of regional information."
@@ -156,7 +159,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/fact.ts",
-        "line": 4
+        "line": 6
       },
       "methods": [
         {
@@ -167,7 +170,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 21
+            "line": 23
           },
           "name": "find",
           "parameters": [
@@ -205,7 +208,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 49
+            "line": 51
           },
           "name": "register",
           "parameters": [
@@ -239,7 +242,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 33
+            "line": 35
           },
           "name": "requireFact",
           "parameters": [
@@ -276,7 +279,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 66
+            "line": 68
           },
           "name": "unregister",
           "parameters": [
@@ -322,7 +325,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 9
+            "line": 11
           },
           "name": "regions",
           "static": true,
@@ -341,6 +344,9 @@
     "@aws-cdk/region-info.FactName": {
       "assembly": "@aws-cdk/region-info",
       "docs": {
+        "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",
         "stability": "stable",
         "summary": "All standardized fact names."
@@ -354,7 +360,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/fact.ts",
-        "line": 104
+        "line": 106
       },
       "methods": [
         {
@@ -364,7 +370,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 168
+            "line": 170
           },
           "name": "cloudwatchLambdaInsightsVersion",
           "parameters": [
@@ -373,6 +379,13 @@
               "type": {
                 "primitive": "string"
               }
+            },
+            {
+              "name": "arch",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
             }
           ],
           "returns": {
@@ -389,7 +402,7 @@
           },
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 179
+            "line": 184
           },
           "name": "servicePrincipal",
           "parameters": [
@@ -422,7 +435,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 158
+            "line": 160
           },
           "name": "APPMESH_ECR_ACCOUNT",
           "static": true,
@@ -440,7 +453,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 119
+            "line": 121
           },
           "name": "CDK_METADATA_RESOURCE_AVAILABLE",
           "static": true,
@@ -457,7 +470,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 152
+            "line": 154
           },
           "name": "DLC_REPOSITORY_ACCOUNT",
           "static": true,
@@ -474,7 +487,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 113
+            "line": 115
           },
           "name": "DOMAIN_SUFFIX",
           "static": true,
@@ -491,7 +504,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 134
+            "line": 136
           },
           "name": "EBS_ENV_ENDPOINT_HOSTED_ZONE_ID",
           "static": true,
@@ -508,7 +521,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 146
+            "line": 148
           },
           "name": "ELBV2_ACCOUNT",
           "static": true,
@@ -525,7 +538,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 163
+            "line": 165
           },
           "name": "FIREHOSE_CIDR_BLOCK",
           "static": true,
@@ -542,7 +555,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 108
+            "line": 110
           },
           "name": "PARTITION",
           "static": true,
@@ -559,7 +572,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 124
+            "line": 126
           },
           "name": "S3_STATIC_WEBSITE_ENDPOINT",
           "static": true,
@@ -576,7 +589,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 129
+            "line": 131
           },
           "name": "S3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_ID",
           "static": true,
@@ -593,7 +606,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 141
+            "line": 143
           },
           "name": "VPC_ENDPOINT_SERVICE_NAME_PREFIX",
           "static": true,
@@ -614,7 +627,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/fact.ts",
-        "line": 84
+        "line": 86
       },
       "name": "IFact",
       "properties": [
@@ -628,7 +641,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 93
+            "line": 95
           },
           "name": "name",
           "type": {
@@ -644,7 +657,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 88
+            "line": 90
           },
           "name": "region",
           "type": {
@@ -660,7 +673,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/fact.ts",
-            "line": 98
+            "line": 100
           },
           "name": "value",
           "optional": true,
@@ -674,6 +687,9 @@
     "@aws-cdk/region-info.RegionInfo": {
       "assembly": "@aws-cdk/region-info",
       "docs": {
+        "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",
         "stability": "stable",
         "summary": "Information pertaining to an AWS region."
@@ -682,7 +698,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/region-info.ts",
-        "line": 6
+        "line": 7
       },
       "methods": [
         {
@@ -692,7 +708,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 39
+            "line": 60
           },
           "name": "get",
           "parameters": [
@@ -713,6 +729,56 @@
           },
           "static": true
         },
+        {
+          "docs": {
+            "returns": "a mapping with AWS region codes as the keys,\nand the fact in the given region as the value for that key",
+            "stability": "stable",
+            "summary": "Retrieves a collection of all fact values for all regions, limited to some partitions."
+          },
+          "locationInModule": {
+            "filename": "lib/region-info.ts",
+            "line": 45
+          },
+          "name": "limitedRegionMap",
+          "parameters": [
+            {
+              "docs": {
+                "remarks": "For a list of common fact names, see the FactName class",
+                "summary": "the name of the fact to retrieve values for."
+              },
+              "name": "factName",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "docs": {
+                "remarks": "Defaults\nto `['aws', 'aws-cn']`.",
+                "summary": "list of partitions to retrieve facts for."
+              },
+              "name": "partitions",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "primitive": "string"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "collection": {
+                "elementtype": {
+                  "primitive": "string"
+                },
+                "kind": "map"
+              }
+            }
+          },
+          "static": true
+        },
         {
           "docs": {
             "returns": "a mapping with AWS region codes as the keys,\nand the fact in the given region as the value for that key",
@@ -721,7 +787,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 23
+            "line": 24
           },
           "name": "regionMap",
           "parameters": [
@@ -755,7 +821,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 124
+            "line": 146
           },
           "name": "cloudwatchLambdaInsightsArn",
           "parameters": [
@@ -767,6 +833,16 @@
               "type": {
                 "primitive": "string"
               }
+            },
+            {
+              "docs": {
+                "summary": "the Lambda Function architecture (e.g. 'x86_64' or 'arm64')."
+              },
+              "name": "architecture",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
             }
           ],
           "returns": {
@@ -783,7 +859,7 @@
           },
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 100
+            "line": 121
           },
           "name": "servicePrincipal",
           "parameters": [
@@ -815,7 +891,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 11
+            "line": 12
           },
           "name": "regions",
           "static": true,
@@ -836,7 +912,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 48
+            "line": 69
           },
           "name": "cdkMetadataResourceAvailable",
           "type": {
@@ -850,7 +926,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 43
+            "line": 64
           },
           "name": "name",
           "type": {
@@ -865,7 +941,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 132
+            "line": 154
           },
           "name": "appMeshRepositoryAccount",
           "optional": true,
@@ -881,7 +957,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 116
+            "line": 137
           },
           "name": "dlcRepositoryAccount",
           "optional": true,
@@ -897,7 +973,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 55
+            "line": 76
           },
           "name": "domainSuffix",
           "optional": true,
@@ -913,7 +989,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 83
+            "line": 104
           },
           "name": "ebsEnvEndpointHostedZoneId",
           "optional": true,
@@ -929,7 +1005,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 108
+            "line": 129
           },
           "name": "elbv2Account",
           "optional": true,
@@ -945,7 +1021,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 139
+            "line": 161
           },
           "name": "firehoseCidrBlock",
           "optional": true,
@@ -961,7 +1037,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 62
+            "line": 83
           },
           "name": "partition",
           "optional": true,
@@ -977,7 +1053,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 69
+            "line": 90
           },
           "name": "s3StaticWebsiteEndpoint",
           "optional": true,
@@ -993,7 +1069,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 76
+            "line": 97
           },
           "name": "s3StaticWebsiteHostedZoneId",
           "optional": true,
@@ -1009,7 +1085,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/region-info.ts",
-            "line": 92
+            "line": 113
           },
           "name": "vpcEndpointServiceNamePrefix",
           "optional": true,
@@ -1021,6 +1097,6 @@
       "symbolId": "lib/region-info:RegionInfo"
     }
   },
-  "version": "2.1.0",
+  "version": "2.5.0",
   "fingerprint": "**********"
 }