@aws-cdk/region-info 2.3.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -12,7 +12,7 @@
12
12
  "stability": "stable"
13
13
  },
14
14
  "homepage": "https://github.com/aws/aws-cdk",
15
- "jsiiVersion": "1.47.0 (build 86d2c33)",
15
+ "jsiiVersion": "1.50.0 (build d1830a4)",
16
16
  "keywords": [
17
17
  "aws",
18
18
  "cdk"
@@ -72,7 +72,7 @@
72
72
  "kind": "class",
73
73
  "locationInModule": {
74
74
  "filename": "lib/default.ts",
75
- "line": 4
75
+ "line": 6
76
76
  },
77
77
  "methods": [
78
78
  {
@@ -83,7 +83,7 @@
83
83
  },
84
84
  "locationInModule": {
85
85
  "filename": "lib/default.ts",
86
- "line": 23
86
+ "line": 25
87
87
  },
88
88
  "name": "servicePrincipal",
89
89
  "parameters": [
@@ -91,7 +91,7 @@
91
91
  "docs": {
92
92
  "summary": "the name of the service (s3, s3.amazonaws.com, ...)."
93
93
  },
94
- "name": "service",
94
+ "name": "serviceFqn",
95
95
  "type": {
96
96
  "primitive": "string"
97
97
  }
@@ -107,7 +107,7 @@
107
107
  },
108
108
  {
109
109
  "docs": {
110
- "summary": "the URL suffix for the partition in which the region is located."
110
+ "summary": "deprecated and ignored."
111
111
  },
112
112
  "name": "urlSuffix",
113
113
  "type": {
@@ -134,7 +134,7 @@
134
134
  "immutable": true,
135
135
  "locationInModule": {
136
136
  "filename": "lib/default.ts",
137
- "line": 11
137
+ "line": 13
138
138
  },
139
139
  "name": "VPC_ENDPOINT_SERVICE_NAME_PREFIX",
140
140
  "static": true,
@@ -148,6 +148,9 @@
148
148
  "@aws-cdk/region-info.Fact": {
149
149
  "assembly": "@aws-cdk/region-info",
150
150
  "docs": {
151
+ "custom": {
152
+ "exampleMetadata": "infused"
153
+ },
151
154
  "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",
152
155
  "stability": "stable",
153
156
  "summary": "A database of regional information."
@@ -156,7 +159,7 @@
156
159
  "kind": "class",
157
160
  "locationInModule": {
158
161
  "filename": "lib/fact.ts",
159
- "line": 4
162
+ "line": 6
160
163
  },
161
164
  "methods": [
162
165
  {
@@ -167,7 +170,7 @@
167
170
  },
168
171
  "locationInModule": {
169
172
  "filename": "lib/fact.ts",
170
- "line": 21
173
+ "line": 23
171
174
  },
172
175
  "name": "find",
173
176
  "parameters": [
@@ -205,7 +208,7 @@
205
208
  },
206
209
  "locationInModule": {
207
210
  "filename": "lib/fact.ts",
208
- "line": 49
211
+ "line": 51
209
212
  },
210
213
  "name": "register",
211
214
  "parameters": [
@@ -239,7 +242,7 @@
239
242
  },
240
243
  "locationInModule": {
241
244
  "filename": "lib/fact.ts",
242
- "line": 33
245
+ "line": 35
243
246
  },
244
247
  "name": "requireFact",
245
248
  "parameters": [
@@ -276,7 +279,7 @@
276
279
  },
277
280
  "locationInModule": {
278
281
  "filename": "lib/fact.ts",
279
- "line": 66
282
+ "line": 68
280
283
  },
281
284
  "name": "unregister",
282
285
  "parameters": [
@@ -322,7 +325,7 @@
322
325
  "immutable": true,
323
326
  "locationInModule": {
324
327
  "filename": "lib/fact.ts",
325
- "line": 9
328
+ "line": 11
326
329
  },
327
330
  "name": "regions",
328
331
  "static": true,
@@ -341,6 +344,9 @@
341
344
  "@aws-cdk/region-info.FactName": {
342
345
  "assembly": "@aws-cdk/region-info",
343
346
  "docs": {
347
+ "custom": {
348
+ "exampleMetadata": "infused"
349
+ },
344
350
  "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",
345
351
  "stability": "stable",
346
352
  "summary": "All standardized fact names."
@@ -354,7 +360,7 @@
354
360
  "kind": "class",
355
361
  "locationInModule": {
356
362
  "filename": "lib/fact.ts",
357
- "line": 104
363
+ "line": 106
358
364
  },
359
365
  "methods": [
360
366
  {
@@ -364,7 +370,7 @@
364
370
  },
365
371
  "locationInModule": {
366
372
  "filename": "lib/fact.ts",
367
- "line": 168
373
+ "line": 170
368
374
  },
369
375
  "name": "cloudwatchLambdaInsightsVersion",
370
376
  "parameters": [
@@ -396,7 +402,7 @@
396
402
  },
397
403
  "locationInModule": {
398
404
  "filename": "lib/fact.ts",
399
- "line": 182
405
+ "line": 184
400
406
  },
401
407
  "name": "servicePrincipal",
402
408
  "parameters": [
@@ -429,7 +435,7 @@
429
435
  "immutable": true,
430
436
  "locationInModule": {
431
437
  "filename": "lib/fact.ts",
432
- "line": 158
438
+ "line": 160
433
439
  },
434
440
  "name": "APPMESH_ECR_ACCOUNT",
435
441
  "static": true,
@@ -447,7 +453,7 @@
447
453
  "immutable": true,
448
454
  "locationInModule": {
449
455
  "filename": "lib/fact.ts",
450
- "line": 119
456
+ "line": 121
451
457
  },
452
458
  "name": "CDK_METADATA_RESOURCE_AVAILABLE",
453
459
  "static": true,
@@ -464,7 +470,7 @@
464
470
  "immutable": true,
465
471
  "locationInModule": {
466
472
  "filename": "lib/fact.ts",
467
- "line": 152
473
+ "line": 154
468
474
  },
469
475
  "name": "DLC_REPOSITORY_ACCOUNT",
470
476
  "static": true,
@@ -481,7 +487,7 @@
481
487
  "immutable": true,
482
488
  "locationInModule": {
483
489
  "filename": "lib/fact.ts",
484
- "line": 113
490
+ "line": 115
485
491
  },
486
492
  "name": "DOMAIN_SUFFIX",
487
493
  "static": true,
@@ -498,7 +504,7 @@
498
504
  "immutable": true,
499
505
  "locationInModule": {
500
506
  "filename": "lib/fact.ts",
501
- "line": 134
507
+ "line": 136
502
508
  },
503
509
  "name": "EBS_ENV_ENDPOINT_HOSTED_ZONE_ID",
504
510
  "static": true,
@@ -515,7 +521,7 @@
515
521
  "immutable": true,
516
522
  "locationInModule": {
517
523
  "filename": "lib/fact.ts",
518
- "line": 146
524
+ "line": 148
519
525
  },
520
526
  "name": "ELBV2_ACCOUNT",
521
527
  "static": true,
@@ -532,7 +538,7 @@
532
538
  "immutable": true,
533
539
  "locationInModule": {
534
540
  "filename": "lib/fact.ts",
535
- "line": 163
541
+ "line": 165
536
542
  },
537
543
  "name": "FIREHOSE_CIDR_BLOCK",
538
544
  "static": true,
@@ -549,7 +555,7 @@
549
555
  "immutable": true,
550
556
  "locationInModule": {
551
557
  "filename": "lib/fact.ts",
552
- "line": 108
558
+ "line": 110
553
559
  },
554
560
  "name": "PARTITION",
555
561
  "static": true,
@@ -566,7 +572,7 @@
566
572
  "immutable": true,
567
573
  "locationInModule": {
568
574
  "filename": "lib/fact.ts",
569
- "line": 124
575
+ "line": 126
570
576
  },
571
577
  "name": "S3_STATIC_WEBSITE_ENDPOINT",
572
578
  "static": true,
@@ -583,7 +589,7 @@
583
589
  "immutable": true,
584
590
  "locationInModule": {
585
591
  "filename": "lib/fact.ts",
586
- "line": 129
592
+ "line": 131
587
593
  },
588
594
  "name": "S3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_ID",
589
595
  "static": true,
@@ -600,7 +606,7 @@
600
606
  "immutable": true,
601
607
  "locationInModule": {
602
608
  "filename": "lib/fact.ts",
603
- "line": 141
609
+ "line": 143
604
610
  },
605
611
  "name": "VPC_ENDPOINT_SERVICE_NAME_PREFIX",
606
612
  "static": true,
@@ -621,7 +627,7 @@
621
627
  "kind": "interface",
622
628
  "locationInModule": {
623
629
  "filename": "lib/fact.ts",
624
- "line": 84
630
+ "line": 86
625
631
  },
626
632
  "name": "IFact",
627
633
  "properties": [
@@ -635,7 +641,7 @@
635
641
  "immutable": true,
636
642
  "locationInModule": {
637
643
  "filename": "lib/fact.ts",
638
- "line": 93
644
+ "line": 95
639
645
  },
640
646
  "name": "name",
641
647
  "type": {
@@ -651,7 +657,7 @@
651
657
  "immutable": true,
652
658
  "locationInModule": {
653
659
  "filename": "lib/fact.ts",
654
- "line": 88
660
+ "line": 90
655
661
  },
656
662
  "name": "region",
657
663
  "type": {
@@ -667,7 +673,7 @@
667
673
  "immutable": true,
668
674
  "locationInModule": {
669
675
  "filename": "lib/fact.ts",
670
- "line": 98
676
+ "line": 100
671
677
  },
672
678
  "name": "value",
673
679
  "optional": true,
@@ -681,6 +687,9 @@
681
687
  "@aws-cdk/region-info.RegionInfo": {
682
688
  "assembly": "@aws-cdk/region-info",
683
689
  "docs": {
690
+ "custom": {
691
+ "exampleMetadata": "infused"
692
+ },
684
693
  "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",
685
694
  "stability": "stable",
686
695
  "summary": "Information pertaining to an AWS region."
@@ -689,7 +698,7 @@
689
698
  "kind": "class",
690
699
  "locationInModule": {
691
700
  "filename": "lib/region-info.ts",
692
- "line": 6
701
+ "line": 7
693
702
  },
694
703
  "methods": [
695
704
  {
@@ -699,7 +708,7 @@
699
708
  },
700
709
  "locationInModule": {
701
710
  "filename": "lib/region-info.ts",
702
- "line": 39
711
+ "line": 60
703
712
  },
704
713
  "name": "get",
705
714
  "parameters": [
@@ -720,6 +729,56 @@
720
729
  },
721
730
  "static": true
722
731
  },
732
+ {
733
+ "docs": {
734
+ "returns": "a mapping with AWS region codes as the keys,\nand the fact in the given region as the value for that key",
735
+ "stability": "stable",
736
+ "summary": "Retrieves a collection of all fact values for all regions, limited to some partitions."
737
+ },
738
+ "locationInModule": {
739
+ "filename": "lib/region-info.ts",
740
+ "line": 45
741
+ },
742
+ "name": "limitedRegionMap",
743
+ "parameters": [
744
+ {
745
+ "docs": {
746
+ "remarks": "For a list of common fact names, see the FactName class",
747
+ "summary": "the name of the fact to retrieve values for."
748
+ },
749
+ "name": "factName",
750
+ "type": {
751
+ "primitive": "string"
752
+ }
753
+ },
754
+ {
755
+ "docs": {
756
+ "remarks": "Defaults\nto `['aws', 'aws-cn']`.",
757
+ "summary": "list of partitions to retrieve facts for."
758
+ },
759
+ "name": "partitions",
760
+ "type": {
761
+ "collection": {
762
+ "elementtype": {
763
+ "primitive": "string"
764
+ },
765
+ "kind": "array"
766
+ }
767
+ }
768
+ }
769
+ ],
770
+ "returns": {
771
+ "type": {
772
+ "collection": {
773
+ "elementtype": {
774
+ "primitive": "string"
775
+ },
776
+ "kind": "map"
777
+ }
778
+ }
779
+ },
780
+ "static": true
781
+ },
723
782
  {
724
783
  "docs": {
725
784
  "returns": "a mapping with AWS region codes as the keys,\nand the fact in the given region as the value for that key",
@@ -728,7 +787,7 @@
728
787
  },
729
788
  "locationInModule": {
730
789
  "filename": "lib/region-info.ts",
731
- "line": 23
790
+ "line": 24
732
791
  },
733
792
  "name": "regionMap",
734
793
  "parameters": [
@@ -762,7 +821,7 @@
762
821
  },
763
822
  "locationInModule": {
764
823
  "filename": "lib/region-info.ts",
765
- "line": 125
824
+ "line": 146
766
825
  },
767
826
  "name": "cloudwatchLambdaInsightsArn",
768
827
  "parameters": [
@@ -800,7 +859,7 @@
800
859
  },
801
860
  "locationInModule": {
802
861
  "filename": "lib/region-info.ts",
803
- "line": 100
862
+ "line": 121
804
863
  },
805
864
  "name": "servicePrincipal",
806
865
  "parameters": [
@@ -832,7 +891,7 @@
832
891
  "immutable": true,
833
892
  "locationInModule": {
834
893
  "filename": "lib/region-info.ts",
835
- "line": 11
894
+ "line": 12
836
895
  },
837
896
  "name": "regions",
838
897
  "static": true,
@@ -853,7 +912,7 @@
853
912
  "immutable": true,
854
913
  "locationInModule": {
855
914
  "filename": "lib/region-info.ts",
856
- "line": 48
915
+ "line": 69
857
916
  },
858
917
  "name": "cdkMetadataResourceAvailable",
859
918
  "type": {
@@ -867,7 +926,7 @@
867
926
  "immutable": true,
868
927
  "locationInModule": {
869
928
  "filename": "lib/region-info.ts",
870
- "line": 43
929
+ "line": 64
871
930
  },
872
931
  "name": "name",
873
932
  "type": {
@@ -882,7 +941,7 @@
882
941
  "immutable": true,
883
942
  "locationInModule": {
884
943
  "filename": "lib/region-info.ts",
885
- "line": 133
944
+ "line": 154
886
945
  },
887
946
  "name": "appMeshRepositoryAccount",
888
947
  "optional": true,
@@ -898,7 +957,7 @@
898
957
  "immutable": true,
899
958
  "locationInModule": {
900
959
  "filename": "lib/region-info.ts",
901
- "line": 116
960
+ "line": 137
902
961
  },
903
962
  "name": "dlcRepositoryAccount",
904
963
  "optional": true,
@@ -914,7 +973,7 @@
914
973
  "immutable": true,
915
974
  "locationInModule": {
916
975
  "filename": "lib/region-info.ts",
917
- "line": 55
976
+ "line": 76
918
977
  },
919
978
  "name": "domainSuffix",
920
979
  "optional": true,
@@ -930,7 +989,7 @@
930
989
  "immutable": true,
931
990
  "locationInModule": {
932
991
  "filename": "lib/region-info.ts",
933
- "line": 83
992
+ "line": 104
934
993
  },
935
994
  "name": "ebsEnvEndpointHostedZoneId",
936
995
  "optional": true,
@@ -946,7 +1005,7 @@
946
1005
  "immutable": true,
947
1006
  "locationInModule": {
948
1007
  "filename": "lib/region-info.ts",
949
- "line": 108
1008
+ "line": 129
950
1009
  },
951
1010
  "name": "elbv2Account",
952
1011
  "optional": true,
@@ -962,7 +1021,7 @@
962
1021
  "immutable": true,
963
1022
  "locationInModule": {
964
1023
  "filename": "lib/region-info.ts",
965
- "line": 140
1024
+ "line": 161
966
1025
  },
967
1026
  "name": "firehoseCidrBlock",
968
1027
  "optional": true,
@@ -978,7 +1037,7 @@
978
1037
  "immutable": true,
979
1038
  "locationInModule": {
980
1039
  "filename": "lib/region-info.ts",
981
- "line": 62
1040
+ "line": 83
982
1041
  },
983
1042
  "name": "partition",
984
1043
  "optional": true,
@@ -994,7 +1053,7 @@
994
1053
  "immutable": true,
995
1054
  "locationInModule": {
996
1055
  "filename": "lib/region-info.ts",
997
- "line": 69
1056
+ "line": 90
998
1057
  },
999
1058
  "name": "s3StaticWebsiteEndpoint",
1000
1059
  "optional": true,
@@ -1010,7 +1069,7 @@
1010
1069
  "immutable": true,
1011
1070
  "locationInModule": {
1012
1071
  "filename": "lib/region-info.ts",
1013
- "line": 76
1072
+ "line": 97
1014
1073
  },
1015
1074
  "name": "s3StaticWebsiteHostedZoneId",
1016
1075
  "optional": true,
@@ -1026,7 +1085,7 @@
1026
1085
  "immutable": true,
1027
1086
  "locationInModule": {
1028
1087
  "filename": "lib/region-info.ts",
1029
- "line": 92
1088
+ "line": 113
1030
1089
  },
1031
1090
  "name": "vpcEndpointServiceNamePrefix",
1032
1091
  "optional": true,
@@ -1038,6 +1097,6 @@
1038
1097
  "symbolId": "lib/region-info:RegionInfo"
1039
1098
  }
1040
1099
  },
1041
- "version": "2.3.0",
1100
+ "version": "2.4.0",
1042
1101
  "fingerprint": "**********"
1043
1102
  }
package/.jsii.tabl.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "version": "2",
3
- "toolVersion": "1.47.0",
3
+ "toolVersion": "1.50.0",
4
4
  "snippets": {
5
5
  "8c2cf5382985a73a9d345453f03a663f572ed57348c2baa7ba30b2aa39fc278d": {
6
6
  "translations": {
@@ -53,7 +53,7 @@
53
53
  "258": 1,
54
54
  "290": 1
55
55
  },
56
- "fqnsFingerprint": "5c194d6d478422dea865c4567106f6bf1581826e044eac351bba63495c69013d"
56
+ "fqnsFingerprint": "97ec6b3ee5dcd55ca63753f03b0a23616036e346c91ff93309e28737431af21d"
57
57
  },
58
58
  "43074915e3fbb4af099979815e42bf34c93fce972721f3e0df2665eb1a59754c": {
59
59
  "translations": {
@@ -351,7 +351,7 @@
351
351
  "258": 1,
352
352
  "290": 1
353
353
  },
354
- "fqnsFingerprint": "5c194d6d478422dea865c4567106f6bf1581826e044eac351bba63495c69013d"
354
+ "fqnsFingerprint": "97ec6b3ee5dcd55ca63753f03b0a23616036e346c91ff93309e28737431af21d"
355
355
  }
356
356
  }
357
357
  }
package/LICENSE CHANGED
@@ -186,7 +186,7 @@
186
186
  same "printed page" as the copyright notice for easier
187
187
  identification within third-party archives.
188
188
 
189
- Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
189
+ Copyright 2018-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
190
190
 
191
191
  Licensed under the Apache License, Version 2.0 (the "License");
192
192
  you may not use this file except in compliance with the License.
package/NOTICE CHANGED
@@ -1,2 +1,2 @@
1
1
  AWS Cloud Development Kit (AWS CDK)
2
- Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ Copyright 2018-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -1,4 +1,3 @@
1
- export declare const AWS_OLDER_REGIONS: Set<string>;
2
1
  export declare const AWS_CDK_METADATA: Set<string>;
3
2
  /**
4
3
  * The hosted zone Id if using an alias record in Route53.