@btc-embedded/cdk-extensions 0.11.0 → 0.12.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.
Files changed (45) hide show
  1. package/.jsii +272 -67
  2. package/API.md +192 -37
  3. package/CHANGELOG.md +18 -0
  4. package/lib/constructs/EventPipe.js +4 -4
  5. package/lib/constructs/S3Bucket.js +1 -1
  6. package/lib/constructs/SecureRestApi.js +1 -1
  7. package/lib/constructs/SecureRestApiV2.js +1 -1
  8. package/lib/extensions/ApiGatewayExtension.js +1 -1
  9. package/lib/extensions/ApplicationLoadBalancerExtension.js +1 -1
  10. package/lib/extensions/ApplicationLoadBalancerExtensionV2.js +1 -1
  11. package/lib/extensions/CloudMapExtension.js +1 -1
  12. package/lib/extensions/DeactivatableServiceExtension.js +1 -1
  13. package/lib/extensions/DocumentDbAccessExtension.js +1 -1
  14. package/lib/extensions/DomainEventMessagingExtension.js +1 -1
  15. package/lib/extensions/ExtraContainerExtension.js +1 -1
  16. package/lib/extensions/HTTPApiExtension.js +1 -1
  17. package/lib/extensions/LogExtension.d.ts +8 -10
  18. package/lib/extensions/LogExtension.js +10 -8
  19. package/lib/extensions/ModifyContainerDefinitionExtension.js +1 -1
  20. package/lib/extensions/ModifyTaskDefinitionExtension.js +1 -1
  21. package/lib/extensions/OpenTelemetryExtension.js +1 -1
  22. package/lib/extensions/PostgresDbAccessExtension.js +1 -1
  23. package/lib/extensions/SharedVolumeExtension.js +1 -1
  24. package/lib/extensions/TcpKeepAliveExtension.js +1 -1
  25. package/lib/platform/ApiGateway.js +4 -3
  26. package/lib/platform/ApiGatewayV2.js +2 -2
  27. package/lib/platform/ApplicationLoadBalancer.js +1 -1
  28. package/lib/platform/ApplicationLoadBalancerV2.js +2 -2
  29. package/lib/platform/BTCLogGroup.d.ts +54 -0
  30. package/lib/platform/BTCLogGroup.js +49 -0
  31. package/lib/platform/CognitoUserPool.js +2 -2
  32. package/lib/platform/DefaultUserPoolClients.js +1 -1
  33. package/lib/platform/DocumentDB.js +2 -2
  34. package/lib/platform/PrivateDnsNamespace.js +1 -1
  35. package/lib/platform/ResourceServer.js +1 -1
  36. package/lib/platform/Vpc.js +1 -1
  37. package/lib/platform/index.d.ts +1 -0
  38. package/lib/platform/index.js +2 -1
  39. package/lib/utils/StackParameter.js +1 -1
  40. package/lib/utils/functions.js +10 -2
  41. package/lib/utils/index.d.ts +0 -1
  42. package/lib/utils/index.js +1 -2
  43. package/package.json +1 -1
  44. package/lib/utils/BTCLogGroup.d.ts +0 -29
  45. package/lib/utils/BTCLogGroup.js +0 -27
package/.jsii CHANGED
@@ -3976,7 +3976,7 @@
3976
3976
  },
3977
3977
  "locationInModule": {
3978
3978
  "filename": "src/platform/ApiGateway.ts",
3979
- "line": 80
3979
+ "line": 81
3980
3980
  },
3981
3981
  "parameters": [
3982
3982
  {
@@ -4002,7 +4002,7 @@
4002
4002
  "kind": "class",
4003
4003
  "locationInModule": {
4004
4004
  "filename": "src/platform/ApiGateway.ts",
4005
- "line": 73
4005
+ "line": 74
4006
4006
  },
4007
4007
  "name": "ApiGateway",
4008
4008
  "symbolId": "src/platform/ApiGateway:ApiGateway"
@@ -4164,7 +4164,7 @@
4164
4164
  "kind": "interface",
4165
4165
  "locationInModule": {
4166
4166
  "filename": "src/platform/ApiGateway.ts",
4167
- "line": 21
4167
+ "line": 22
4168
4168
  },
4169
4169
  "name": "ApiGatewayProps",
4170
4170
  "properties": [
@@ -4177,7 +4177,7 @@
4177
4177
  "immutable": true,
4178
4178
  "locationInModule": {
4179
4179
  "filename": "src/platform/ApiGateway.ts",
4180
- "line": 45
4180
+ "line": 46
4181
4181
  },
4182
4182
  "name": "domainPrefix",
4183
4183
  "type": {
@@ -4193,7 +4193,7 @@
4193
4193
  "immutable": true,
4194
4194
  "locationInModule": {
4195
4195
  "filename": "src/platform/ApiGateway.ts",
4196
- "line": 50
4196
+ "line": 51
4197
4197
  },
4198
4198
  "name": "hostedZone",
4199
4199
  "type": {
@@ -4209,7 +4209,7 @@
4209
4209
  "immutable": true,
4210
4210
  "locationInModule": {
4211
4211
  "filename": "src/platform/ApiGateway.ts",
4212
- "line": 25
4212
+ "line": 26
4213
4213
  },
4214
4214
  "name": "stackName",
4215
4215
  "type": {
@@ -4225,7 +4225,7 @@
4225
4225
  "immutable": true,
4226
4226
  "locationInModule": {
4227
4227
  "filename": "src/platform/ApiGateway.ts",
4228
- "line": 35
4228
+ "line": 36
4229
4229
  },
4230
4230
  "name": "userPool",
4231
4231
  "type": {
@@ -4241,7 +4241,7 @@
4241
4241
  "immutable": true,
4242
4242
  "locationInModule": {
4243
4243
  "filename": "src/platform/ApiGateway.ts",
4244
- "line": 40
4244
+ "line": 41
4245
4245
  },
4246
4246
  "name": "userPoolClients",
4247
4247
  "type": {
@@ -4262,7 +4262,7 @@
4262
4262
  "immutable": true,
4263
4263
  "locationInModule": {
4264
4264
  "filename": "src/platform/ApiGateway.ts",
4265
- "line": 30
4265
+ "line": 31
4266
4266
  },
4267
4267
  "name": "vpc",
4268
4268
  "type": {
@@ -4279,7 +4279,7 @@
4279
4279
  "immutable": true,
4280
4280
  "locationInModule": {
4281
4281
  "filename": "src/platform/ApiGateway.ts",
4282
- "line": 57
4282
+ "line": 58
4283
4283
  },
4284
4284
  "name": "enableAccessLogs",
4285
4285
  "optional": true,
@@ -5728,8 +5728,8 @@
5728
5728
  "stability": "experimental"
5729
5729
  },
5730
5730
  "locationInModule": {
5731
- "filename": "src/utils/BTCLogGroup.ts",
5732
- "line": 34
5731
+ "filename": "src/platform/BTCLogGroup.ts",
5732
+ "line": 77
5733
5733
  },
5734
5734
  "parameters": [
5735
5735
  {
@@ -5747,18 +5747,97 @@
5747
5747
  {
5748
5748
  "name": "options",
5749
5749
  "type": {
5750
- "fqn": "@btc-embedded/cdk-extensions.BTCLogGroupOptions"
5750
+ "union": {
5751
+ "types": [
5752
+ {
5753
+ "fqn": "@btc-embedded/cdk-extensions.BTCUniqueLogGroupOptions"
5754
+ },
5755
+ {
5756
+ "fqn": "@btc-embedded/cdk-extensions.BTCLogGroupOptions"
5757
+ }
5758
+ ]
5759
+ }
5751
5760
  }
5752
5761
  }
5753
5762
  ]
5754
5763
  },
5755
5764
  "kind": "class",
5756
5765
  "locationInModule": {
5757
- "filename": "src/utils/BTCLogGroup.ts",
5758
- "line": 33
5766
+ "filename": "src/platform/BTCLogGroup.ts",
5767
+ "line": 58
5759
5768
  },
5769
+ "methods": [
5770
+ {
5771
+ "docs": {
5772
+ "stability": "experimental"
5773
+ },
5774
+ "locationInModule": {
5775
+ "filename": "src/platform/BTCLogGroup.ts",
5776
+ "line": 59
5777
+ },
5778
+ "name": "fromBasePlatform",
5779
+ "parameters": [
5780
+ {
5781
+ "name": "scope",
5782
+ "type": {
5783
+ "fqn": "constructs.Construct"
5784
+ }
5785
+ },
5786
+ {
5787
+ "name": "id",
5788
+ "type": {
5789
+ "primitive": "string"
5790
+ }
5791
+ },
5792
+ {
5793
+ "name": "__2",
5794
+ "type": {
5795
+ "fqn": "@btc-embedded/cdk-extensions.BTCLogGroupLookupOptions"
5796
+ }
5797
+ }
5798
+ ],
5799
+ "returns": {
5800
+ "type": {
5801
+ "fqn": "aws-cdk-lib.aws_logs.LogGroup"
5802
+ }
5803
+ },
5804
+ "static": true
5805
+ }
5806
+ ],
5760
5807
  "name": "BTCLogGroup",
5761
- "symbolId": "src/utils/BTCLogGroup:BTCLogGroup"
5808
+ "symbolId": "src/platform/BTCLogGroup:BTCLogGroup"
5809
+ },
5810
+ "@btc-embedded/cdk-extensions.BTCLogGroupLookupOptions": {
5811
+ "assembly": "@btc-embedded/cdk-extensions",
5812
+ "datatype": true,
5813
+ "docs": {
5814
+ "stability": "experimental"
5815
+ },
5816
+ "fqn": "@btc-embedded/cdk-extensions.BTCLogGroupLookupOptions",
5817
+ "kind": "interface",
5818
+ "locationInModule": {
5819
+ "filename": "src/platform/BTCLogGroup.ts",
5820
+ "line": 51
5821
+ },
5822
+ "name": "BTCLogGroupLookupOptions",
5823
+ "properties": [
5824
+ {
5825
+ "abstract": true,
5826
+ "docs": {
5827
+ "stability": "experimental"
5828
+ },
5829
+ "immutable": true,
5830
+ "locationInModule": {
5831
+ "filename": "src/platform/BTCLogGroup.ts",
5832
+ "line": 52
5833
+ },
5834
+ "name": "basePlatform",
5835
+ "type": {
5836
+ "primitive": "string"
5837
+ }
5838
+ }
5839
+ ],
5840
+ "symbolId": "src/platform/BTCLogGroup:BTCLogGroupLookupOptions"
5762
5841
  },
5763
5842
  "@btc-embedded/cdk-extensions.BTCLogGroupOptions": {
5764
5843
  "assembly": "@btc-embedded/cdk-extensions",
@@ -5769,10 +5848,81 @@
5769
5848
  "fqn": "@btc-embedded/cdk-extensions.BTCLogGroupOptions",
5770
5849
  "kind": "interface",
5771
5850
  "locationInModule": {
5772
- "filename": "src/utils/BTCLogGroup.ts",
5773
- "line": 6
5851
+ "filename": "src/platform/BTCLogGroup.ts",
5852
+ "line": 40
5774
5853
  },
5775
5854
  "name": "BTCLogGroupOptions",
5855
+ "properties": [
5856
+ {
5857
+ "abstract": true,
5858
+ "docs": {
5859
+ "default": "the stack name",
5860
+ "remarks": "This name will be used as log group name.",
5861
+ "stability": "experimental",
5862
+ "summary": "Name of the application."
5863
+ },
5864
+ "immutable": true,
5865
+ "locationInModule": {
5866
+ "filename": "src/platform/BTCLogGroup.ts",
5867
+ "line": 48
5868
+ },
5869
+ "name": "appName",
5870
+ "type": {
5871
+ "primitive": "string"
5872
+ }
5873
+ },
5874
+ {
5875
+ "abstract": true,
5876
+ "docs": {
5877
+ "default": "Destroy",
5878
+ "stability": "experimental",
5879
+ "summary": "Specify whether to delete the loggroup when destroying the stack."
5880
+ },
5881
+ "immutable": true,
5882
+ "locationInModule": {
5883
+ "filename": "src/platform/BTCLogGroup.ts",
5884
+ "line": 20
5885
+ },
5886
+ "name": "removalPolicy",
5887
+ "optional": true,
5888
+ "type": {
5889
+ "fqn": "aws-cdk-lib.RemovalPolicy"
5890
+ }
5891
+ },
5892
+ {
5893
+ "abstract": true,
5894
+ "docs": {
5895
+ "default": "one month",
5896
+ "stability": "experimental",
5897
+ "summary": "Specify how long the logs should be kept."
5898
+ },
5899
+ "immutable": true,
5900
+ "locationInModule": {
5901
+ "filename": "src/platform/BTCLogGroup.ts",
5902
+ "line": 13
5903
+ },
5904
+ "name": "retention",
5905
+ "optional": true,
5906
+ "type": {
5907
+ "fqn": "aws-cdk-lib.aws_logs.RetentionDays"
5908
+ }
5909
+ }
5910
+ ],
5911
+ "symbolId": "src/platform/BTCLogGroup:BTCLogGroupOptions"
5912
+ },
5913
+ "@btc-embedded/cdk-extensions.BTCUniqueLogGroupOptions": {
5914
+ "assembly": "@btc-embedded/cdk-extensions",
5915
+ "datatype": true,
5916
+ "docs": {
5917
+ "stability": "experimental"
5918
+ },
5919
+ "fqn": "@btc-embedded/cdk-extensions.BTCUniqueLogGroupOptions",
5920
+ "kind": "interface",
5921
+ "locationInModule": {
5922
+ "filename": "src/platform/BTCLogGroup.ts",
5923
+ "line": 23
5924
+ },
5925
+ "name": "BTCUniqueLogGroupOptions",
5776
5926
  "properties": [
5777
5927
  {
5778
5928
  "abstract": true,
@@ -5782,8 +5932,8 @@
5782
5932
  },
5783
5933
  "immutable": true,
5784
5934
  "locationInModule": {
5785
- "filename": "src/utils/BTCLogGroup.ts",
5786
- "line": 11
5935
+ "filename": "src/platform/BTCLogGroup.ts",
5936
+ "line": 28
5787
5937
  },
5788
5938
  "name": "logType",
5789
5939
  "type": {
@@ -5800,8 +5950,8 @@
5800
5950
  },
5801
5951
  "immutable": true,
5802
5952
  "locationInModule": {
5803
- "filename": "src/utils/BTCLogGroup.ts",
5804
- "line": 20
5953
+ "filename": "src/platform/BTCLogGroup.ts",
5954
+ "line": 37
5805
5955
  },
5806
5956
  "name": "appName",
5807
5957
  "optional": true,
@@ -5809,6 +5959,24 @@
5809
5959
  "primitive": "string"
5810
5960
  }
5811
5961
  },
5962
+ {
5963
+ "abstract": true,
5964
+ "docs": {
5965
+ "default": "Destroy",
5966
+ "stability": "experimental",
5967
+ "summary": "Specify whether to delete the loggroup when destroying the stack."
5968
+ },
5969
+ "immutable": true,
5970
+ "locationInModule": {
5971
+ "filename": "src/platform/BTCLogGroup.ts",
5972
+ "line": 20
5973
+ },
5974
+ "name": "removalPolicy",
5975
+ "optional": true,
5976
+ "type": {
5977
+ "fqn": "aws-cdk-lib.RemovalPolicy"
5978
+ }
5979
+ },
5812
5980
  {
5813
5981
  "abstract": true,
5814
5982
  "docs": {
@@ -5818,8 +5986,8 @@
5818
5986
  },
5819
5987
  "immutable": true,
5820
5988
  "locationInModule": {
5821
- "filename": "src/utils/BTCLogGroup.ts",
5822
- "line": 27
5989
+ "filename": "src/platform/BTCLogGroup.ts",
5990
+ "line": 13
5823
5991
  },
5824
5992
  "name": "retention",
5825
5993
  "optional": true,
@@ -5828,7 +5996,7 @@
5828
5996
  }
5829
5997
  }
5830
5998
  ],
5831
- "symbolId": "src/utils/BTCLogGroup:BTCLogGroupOptions"
5999
+ "symbolId": "src/platform/BTCLogGroup:BTCUniqueLogGroupOptions"
5832
6000
  },
5833
6001
  "@btc-embedded/cdk-extensions.CloudMapExtension": {
5834
6002
  "assembly": "@btc-embedded/cdk-extensions",
@@ -7804,6 +7972,38 @@
7804
7972
  ],
7805
7973
  "symbolId": "src/constructs/EventPipe:EventPipeProps"
7806
7974
  },
7975
+ "@btc-embedded/cdk-extensions.ExistingLogroupOption": {
7976
+ "assembly": "@btc-embedded/cdk-extensions",
7977
+ "datatype": true,
7978
+ "docs": {
7979
+ "stability": "experimental"
7980
+ },
7981
+ "fqn": "@btc-embedded/cdk-extensions.ExistingLogroupOption",
7982
+ "kind": "interface",
7983
+ "locationInModule": {
7984
+ "filename": "src/extensions/LogExtension.ts",
7985
+ "line": 10
7986
+ },
7987
+ "name": "ExistingLogroupOption",
7988
+ "properties": [
7989
+ {
7990
+ "abstract": true,
7991
+ "docs": {
7992
+ "stability": "experimental"
7993
+ },
7994
+ "immutable": true,
7995
+ "locationInModule": {
7996
+ "filename": "src/extensions/LogExtension.ts",
7997
+ "line": 11
7998
+ },
7999
+ "name": "logGroup",
8000
+ "type": {
8001
+ "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
8002
+ }
8003
+ }
8004
+ ],
8005
+ "symbolId": "src/extensions/LogExtension:ExistingLogroupOption"
8006
+ },
7807
8007
  "@btc-embedded/cdk-extensions.ExtraContainerExtension": {
7808
8008
  "assembly": "@btc-embedded/cdk-extensions",
7809
8009
  "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -8589,6 +8789,38 @@
8589
8789
  ],
8590
8790
  "symbolId": "src/platform/Vpc:IVpc"
8591
8791
  },
8792
+ "@btc-embedded/cdk-extensions.ImportLogGroupOption": {
8793
+ "assembly": "@btc-embedded/cdk-extensions",
8794
+ "datatype": true,
8795
+ "docs": {
8796
+ "stability": "experimental"
8797
+ },
8798
+ "fqn": "@btc-embedded/cdk-extensions.ImportLogGroupOption",
8799
+ "kind": "interface",
8800
+ "locationInModule": {
8801
+ "filename": "src/extensions/LogExtension.ts",
8802
+ "line": 13
8803
+ },
8804
+ "name": "ImportLogGroupOption",
8805
+ "properties": [
8806
+ {
8807
+ "abstract": true,
8808
+ "docs": {
8809
+ "stability": "experimental"
8810
+ },
8811
+ "immutable": true,
8812
+ "locationInModule": {
8813
+ "filename": "src/extensions/LogExtension.ts",
8814
+ "line": 14
8815
+ },
8816
+ "name": "basePlatformName",
8817
+ "type": {
8818
+ "primitive": "string"
8819
+ }
8820
+ }
8821
+ ],
8822
+ "symbolId": "src/extensions/LogExtension:ImportLogGroupOption"
8823
+ },
8592
8824
  "@btc-embedded/cdk-extensions.InputTemplate": {
8593
8825
  "assembly": "@btc-embedded/cdk-extensions",
8594
8826
  "datatype": true,
@@ -8652,14 +8884,22 @@
8652
8884
  },
8653
8885
  "locationInModule": {
8654
8886
  "filename": "src/extensions/LogExtension.ts",
8655
- "line": 41
8887
+ "line": 40
8656
8888
  },
8657
8889
  "parameters": [
8658
8890
  {
8659
8891
  "name": "options",
8660
- "optional": true,
8661
8892
  "type": {
8662
- "fqn": "@btc-embedded/cdk-extensions.LogExtensionOptions"
8893
+ "union": {
8894
+ "types": [
8895
+ {
8896
+ "fqn": "@btc-embedded/cdk-extensions.ExistingLogroupOption"
8897
+ },
8898
+ {
8899
+ "fqn": "@btc-embedded/cdk-extensions.ImportLogGroupOption"
8900
+ }
8901
+ ]
8902
+ }
8663
8903
  }
8664
8904
  }
8665
8905
  ]
@@ -8667,7 +8907,7 @@
8667
8907
  "kind": "class",
8668
8908
  "locationInModule": {
8669
8909
  "filename": "src/extensions/LogExtension.ts",
8670
- "line": 40
8910
+ "line": 38
8671
8911
  },
8672
8912
  "methods": [
8673
8913
  {
@@ -8677,7 +8917,7 @@
8677
8917
  },
8678
8918
  "locationInModule": {
8679
8919
  "filename": "src/extensions/LogExtension.ts",
8680
- "line": 45
8920
+ "line": 53
8681
8921
  },
8682
8922
  "name": "addHooks",
8683
8923
  "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
@@ -8686,41 +8926,6 @@
8686
8926
  "name": "LogExtension",
8687
8927
  "symbolId": "src/extensions/LogExtension:LogExtension"
8688
8928
  },
8689
- "@btc-embedded/cdk-extensions.LogExtensionOptions": {
8690
- "assembly": "@btc-embedded/cdk-extensions",
8691
- "datatype": true,
8692
- "docs": {
8693
- "stability": "experimental"
8694
- },
8695
- "fqn": "@btc-embedded/cdk-extensions.LogExtensionOptions",
8696
- "kind": "interface",
8697
- "locationInModule": {
8698
- "filename": "src/extensions/LogExtension.ts",
8699
- "line": 9
8700
- },
8701
- "name": "LogExtensionOptions",
8702
- "properties": [
8703
- {
8704
- "abstract": true,
8705
- "docs": {
8706
- "default": "the stack name",
8707
- "stability": "experimental",
8708
- "summary": "The name of the application."
8709
- },
8710
- "immutable": true,
8711
- "locationInModule": {
8712
- "filename": "src/extensions/LogExtension.ts",
8713
- "line": 16
8714
- },
8715
- "name": "appName",
8716
- "optional": true,
8717
- "type": {
8718
- "primitive": "string"
8719
- }
8720
- }
8721
- ],
8722
- "symbolId": "src/extensions/LogExtension:LogExtensionOptions"
8723
- },
8724
8929
  "@btc-embedded/cdk-extensions.LogLevel": {
8725
8930
  "assembly": "@btc-embedded/cdk-extensions",
8726
8931
  "docs": {
@@ -11181,6 +11386,6 @@
11181
11386
  "symbolId": "src/platform/Vpc:VpcProps"
11182
11387
  }
11183
11388
  },
11184
- "version": "0.11.0",
11185
- "fingerprint": "h4U437/JRM8grseg46/MOWyuzRi+Osd9J93q/GIWHKc="
11389
+ "version": "0.12.0",
11390
+ "fingerprint": "jfOEd/o+8eylKIgVmBqVIrKUnA8TpAdWC4W2qsxf4r8="
11186
11391
  }