@btc-embedded/cdk-extensions 0.18.1 → 0.19.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 +391 -153
  2. package/API.md +445 -71
  3. package/CHANGELOG.md +7 -0
  4. package/lib/constructs/EventPipe.js +1 -1
  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.d.ts +3 -10
  11. package/lib/extensions/ApplicationLoadBalancerExtensionV2.js +7 -38
  12. package/lib/extensions/CloudMapExtension.js +1 -1
  13. package/lib/extensions/DeactivatableServiceExtension.js +1 -1
  14. package/lib/extensions/DocumentDbAccessExtension.js +1 -1
  15. package/lib/extensions/DomainEventMessagingExtension.js +1 -1
  16. package/lib/extensions/EfsMountExtension.js +1 -1
  17. package/lib/extensions/ExtraContainerExtension.js +1 -1
  18. package/lib/extensions/HTTPApiExtension.js +1 -1
  19. package/lib/extensions/LogExtension.js +1 -1
  20. package/lib/extensions/ModifyContainerDefinitionExtension.js +1 -1
  21. package/lib/extensions/ModifyTaskDefinitionExtension.js +1 -1
  22. package/lib/extensions/OpenIdExtension.d.ts +20 -0
  23. package/lib/extensions/OpenIdExtension.js +52 -0
  24. package/lib/extensions/OpenTelemetryExtension.js +1 -1
  25. package/lib/extensions/PostgresDbAccessExtension.js +1 -1
  26. package/lib/extensions/SharedVolumeExtension.js +1 -1
  27. package/lib/extensions/TcpKeepAliveExtension.js +1 -1
  28. package/lib/extensions/index.d.ts +1 -0
  29. package/lib/extensions/index.js +2 -1
  30. package/lib/platform/ApiGateway.js +1 -1
  31. package/lib/platform/ApiGatewayVpcLink.js +2 -2
  32. package/lib/platform/ApplicationLoadBalancer.js +1 -1
  33. package/lib/platform/ApplicationLoadBalancerV2.d.ts +4 -0
  34. package/lib/platform/ApplicationLoadBalancerV2.js +14 -6
  35. package/lib/platform/BTCLogGroup.js +1 -1
  36. package/lib/platform/CognitoUserPool.d.ts +17 -0
  37. package/lib/platform/CognitoUserPool.js +25 -3
  38. package/lib/platform/DefaultUserPoolClients.js +1 -1
  39. package/lib/platform/DocumentDB.js +2 -2
  40. package/lib/platform/EfsFileSystem.js +1 -1
  41. package/lib/platform/PrivateDnsNamespace.js +1 -1
  42. package/lib/platform/ResourceServer.js +1 -1
  43. package/lib/platform/Vpc.js +1 -1
  44. package/lib/utils/StackParameter.js +1 -1
  45. package/package.json +1 -1
package/API.md CHANGED
@@ -789,6 +789,7 @@ ApplicationLoadBalancerV2.fromBasePlatform(scope: Construct, id: string, __2: Ap
789
789
  | **Name** | **Type** | **Description** |
790
790
  | --- | --- | --- |
791
791
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
792
+ | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
792
793
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2.property.targetGroup">targetGroup</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup</code> | *No description.* |
793
794
 
794
795
  ---
@@ -805,6 +806,16 @@ The tree node.
805
806
 
806
807
  ---
807
808
 
809
+ ##### `domainName`<sup>Required</sup> <a name="domainName" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2.property.domainName"></a>
810
+
811
+ ```typescript
812
+ public readonly domainName: string;
813
+ ```
814
+
815
+ - *Type:* string
816
+
817
+ ---
818
+
808
819
  ##### `targetGroup`<sup>Required</sup> <a name="targetGroup" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2.property.targetGroup"></a>
809
820
 
810
821
  ```typescript
@@ -929,6 +940,7 @@ Any object.
929
940
  | **Name** | **Type** | **Description** |
930
941
  | --- | --- | --- |
931
942
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2Base.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
943
+ | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2Base.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
932
944
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2Base.property.targetGroup">targetGroup</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup</code> | *No description.* |
933
945
 
934
946
  ---
@@ -945,6 +957,16 @@ The tree node.
945
957
 
946
958
  ---
947
959
 
960
+ ##### `domainName`<sup>Required</sup> <a name="domainName" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2Base.property.domainName"></a>
961
+
962
+ ```typescript
963
+ public readonly domainName: string;
964
+ ```
965
+
966
+ - *Type:* string
967
+
968
+ ---
969
+
948
970
  ##### `targetGroup`<sup>Required</sup> <a name="targetGroup" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2Base.property.targetGroup"></a>
949
971
 
950
972
  ```typescript
@@ -1672,6 +1694,8 @@ CognitoUserPool.fromBasePlatform(scope: Construct, id: string, basePlatform: str
1672
1694
  | --- | --- | --- |
1673
1695
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1674
1696
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.apiUserPoolClient">apiUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
1697
+ | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.appClientSecret">appClientSecret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
1698
+ | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.appOpenIdParameters">appOpenIdParameters</a></code> | <code><a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters">AppOpenIdParameters</a></code> | Contains the OpenID parameters of the frontend/web application client. |
1675
1699
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.appUserPoolClient">appUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
1676
1700
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.cognitoUserPoolDomain">cognitoUserPoolDomain</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolDomain</code> | *No description.* |
1677
1701
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPool.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | *No description.* |
@@ -1700,6 +1724,28 @@ public readonly apiUserPoolClient: IUserPoolClient;
1700
1724
 
1701
1725
  ---
1702
1726
 
1727
+ ##### `appClientSecret`<sup>Required</sup> <a name="appClientSecret" id="@btc-embedded/cdk-extensions.CognitoUserPool.property.appClientSecret"></a>
1728
+
1729
+ ```typescript
1730
+ public readonly appClientSecret: ISecret;
1731
+ ```
1732
+
1733
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
1734
+
1735
+ ---
1736
+
1737
+ ##### `appOpenIdParameters`<sup>Required</sup> <a name="appOpenIdParameters" id="@btc-embedded/cdk-extensions.CognitoUserPool.property.appOpenIdParameters"></a>
1738
+
1739
+ ```typescript
1740
+ public readonly appOpenIdParameters: AppOpenIdParameters;
1741
+ ```
1742
+
1743
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters">AppOpenIdParameters</a>
1744
+
1745
+ Contains the OpenID parameters of the frontend/web application client.
1746
+
1747
+ ---
1748
+
1703
1749
  ##### `appUserPoolClient`<sup>Required</sup> <a name="appUserPoolClient" id="@btc-embedded/cdk-extensions.CognitoUserPool.property.appUserPoolClient"></a>
1704
1750
 
1705
1751
  ```typescript
@@ -1846,6 +1892,8 @@ Any object.
1846
1892
  | --- | --- | --- |
1847
1893
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1848
1894
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.apiUserPoolClient">apiUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
1895
+ | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.appClientSecret">appClientSecret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
1896
+ | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.appOpenIdParameters">appOpenIdParameters</a></code> | <code><a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters">AppOpenIdParameters</a></code> | Contains the OpenID parameters of the frontend/web application client. |
1849
1897
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.appUserPoolClient">appUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
1850
1898
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.cognitoUserPoolDomain">cognitoUserPoolDomain</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolDomain</code> | *No description.* |
1851
1899
  | <code><a href="#@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | *No description.* |
@@ -1874,6 +1922,28 @@ public readonly apiUserPoolClient: IUserPoolClient;
1874
1922
 
1875
1923
  ---
1876
1924
 
1925
+ ##### `appClientSecret`<sup>Required</sup> <a name="appClientSecret" id="@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.appClientSecret"></a>
1926
+
1927
+ ```typescript
1928
+ public readonly appClientSecret: ISecret;
1929
+ ```
1930
+
1931
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
1932
+
1933
+ ---
1934
+
1935
+ ##### `appOpenIdParameters`<sup>Required</sup> <a name="appOpenIdParameters" id="@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.appOpenIdParameters"></a>
1936
+
1937
+ ```typescript
1938
+ public readonly appOpenIdParameters: AppOpenIdParameters;
1939
+ ```
1940
+
1941
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters">AppOpenIdParameters</a>
1942
+
1943
+ Contains the OpenID parameters of the frontend/web application client.
1944
+
1945
+ ---
1946
+
1877
1947
  ##### `appUserPoolClient`<sup>Required</sup> <a name="appUserPoolClient" id="@btc-embedded/cdk-extensions.CognitoUserPoolBase.property.appUserPoolClient"></a>
1878
1948
 
1879
1949
  ```typescript
@@ -4961,26 +5031,22 @@ const applicationLoadBalancerExtensionPropsV2: ApplicationLoadBalancerExtensionP
4961
5031
 
4962
5032
  | **Name** | **Type** | **Description** |
4963
5033
  | --- | --- | --- |
4964
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.clientScope">clientScope</a></code> | <code>string</code> | *No description.* |
5034
+ | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.loadBalancer">loadBalancer</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2">ApplicationLoadBalancerV2</a></code> | *No description.* |
4965
5035
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.platformStackName">platformStackName</a></code> | <code>string</code> | *No description.* |
4966
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.userPoolClientSecret">userPoolClientSecret</a></code> | <code>string</code> | *No description.* |
4967
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.applicationLoadBalancer">applicationLoadBalancer</a></code> | <code><a href="#@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2">IApplicationLoadBalancerV2</a></code> | *No description.* |
4968
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.healtCheckPath">healtCheckPath</a></code> | <code>string</code> | *No description.* |
4969
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.path">path</a></code> | <code>string</code> | *No description.* |
4970
5036
 
4971
5037
  ---
4972
5038
 
4973
- ##### `clientScope`<sup>Required</sup> <a name="clientScope" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.clientScope"></a>
5039
+ ##### `loadBalancer`<sup>Optional</sup> <a name="loadBalancer" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.loadBalancer"></a>
4974
5040
 
4975
5041
  ```typescript
4976
- public readonly clientScope: string;
5042
+ public readonly loadBalancer: ApplicationLoadBalancerV2;
4977
5043
  ```
4978
5044
 
4979
- - *Type:* string
5045
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2">ApplicationLoadBalancerV2</a>
4980
5046
 
4981
5047
  ---
4982
5048
 
4983
- ##### `platformStackName`<sup>Required</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.platformStackName"></a>
5049
+ ##### `platformStackName`<sup>Optional</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.platformStackName"></a>
4984
5050
 
4985
5051
  ```typescript
4986
5052
  public readonly platformStackName: string;
@@ -4990,46 +5056,6 @@ public readonly platformStackName: string;
4990
5056
 
4991
5057
  ---
4992
5058
 
4993
- ##### `userPoolClientSecret`<sup>Required</sup> <a name="userPoolClientSecret" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.userPoolClientSecret"></a>
4994
-
4995
- ```typescript
4996
- public readonly userPoolClientSecret: string;
4997
- ```
4998
-
4999
- - *Type:* string
5000
-
5001
- ---
5002
-
5003
- ##### `applicationLoadBalancer`<sup>Optional</sup> <a name="applicationLoadBalancer" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.applicationLoadBalancer"></a>
5004
-
5005
- ```typescript
5006
- public readonly applicationLoadBalancer: IApplicationLoadBalancerV2;
5007
- ```
5008
-
5009
- - *Type:* <a href="#@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2">IApplicationLoadBalancerV2</a>
5010
-
5011
- ---
5012
-
5013
- ##### `healtCheckPath`<sup>Optional</sup> <a name="healtCheckPath" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.healtCheckPath"></a>
5014
-
5015
- ```typescript
5016
- public readonly healtCheckPath: string;
5017
- ```
5018
-
5019
- - *Type:* string
5020
-
5021
- ---
5022
-
5023
- ##### `path`<sup>Optional</sup> <a name="path" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionPropsV2.property.path"></a>
5024
-
5025
- ```typescript
5026
- public readonly path: string;
5027
- ```
5028
-
5029
- - *Type:* string
5030
-
5031
- ---
5032
-
5033
5059
  ### ApplicationLoadBalancerProps <a name="ApplicationLoadBalancerProps" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps"></a>
5034
5060
 
5035
5061
  #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.Initializer"></a>
@@ -5238,6 +5264,67 @@ public readonly basePlatform: string;
5238
5264
 
5239
5265
  ---
5240
5266
 
5267
+ ### AppOpenIdParameters <a name="AppOpenIdParameters" id="@btc-embedded/cdk-extensions.AppOpenIdParameters"></a>
5268
+
5269
+ #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.AppOpenIdParameters.Initializer"></a>
5270
+
5271
+ ```typescript
5272
+ import { AppOpenIdParameters } from '@btc-embedded/cdk-extensions'
5273
+
5274
+ const appOpenIdParameters: AppOpenIdParameters = { ... }
5275
+ ```
5276
+
5277
+ #### Properties <a name="Properties" id="Properties"></a>
5278
+
5279
+ | **Name** | **Type** | **Description** |
5280
+ | --- | --- | --- |
5281
+ | <code><a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters.property.clientId">clientId</a></code> | <code>string</code> | *No description.* |
5282
+ | <code><a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters.property.issuerUrl">issuerUrl</a></code> | <code>string</code> | *No description.* |
5283
+ | <code><a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters.property.scope">scope</a></code> | <code>string</code> | *No description.* |
5284
+ | <code><a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters.property.secret">secret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
5285
+
5286
+ ---
5287
+
5288
+ ##### `clientId`<sup>Required</sup> <a name="clientId" id="@btc-embedded/cdk-extensions.AppOpenIdParameters.property.clientId"></a>
5289
+
5290
+ ```typescript
5291
+ public readonly clientId: string;
5292
+ ```
5293
+
5294
+ - *Type:* string
5295
+
5296
+ ---
5297
+
5298
+ ##### `issuerUrl`<sup>Required</sup> <a name="issuerUrl" id="@btc-embedded/cdk-extensions.AppOpenIdParameters.property.issuerUrl"></a>
5299
+
5300
+ ```typescript
5301
+ public readonly issuerUrl: string;
5302
+ ```
5303
+
5304
+ - *Type:* string
5305
+
5306
+ ---
5307
+
5308
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.AppOpenIdParameters.property.scope"></a>
5309
+
5310
+ ```typescript
5311
+ public readonly scope: string;
5312
+ ```
5313
+
5314
+ - *Type:* string
5315
+
5316
+ ---
5317
+
5318
+ ##### `secret`<sup>Required</sup> <a name="secret" id="@btc-embedded/cdk-extensions.AppOpenIdParameters.property.secret"></a>
5319
+
5320
+ ```typescript
5321
+ public readonly secret: ISecret;
5322
+ ```
5323
+
5324
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
5325
+
5326
+ ---
5327
+
5241
5328
  ### BTCLogGroupLookupOptions <a name="BTCLogGroupLookupOptions" id="@btc-embedded/cdk-extensions.BTCLogGroupLookupOptions"></a>
5242
5329
 
5243
5330
  #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.BTCLogGroupLookupOptions.Initializer"></a>
@@ -7738,6 +7825,49 @@ const inputTemplate: InputTemplate = { ... }
7738
7825
  ```
7739
7826
 
7740
7827
 
7828
+ ### OpenIdExtensionProps <a name="OpenIdExtensionProps" id="@btc-embedded/cdk-extensions.OpenIdExtensionProps"></a>
7829
+
7830
+ #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.OpenIdExtensionProps.Initializer"></a>
7831
+
7832
+ ```typescript
7833
+ import { OpenIdExtensionProps } from '@btc-embedded/cdk-extensions'
7834
+
7835
+ const openIdExtensionProps: OpenIdExtensionProps = { ... }
7836
+ ```
7837
+
7838
+ #### Properties <a name="Properties" id="Properties"></a>
7839
+
7840
+ | **Name** | **Type** | **Description** |
7841
+ | --- | --- | --- |
7842
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtensionProps.property.platformStackName">platformStackName</a></code> | <code>string</code> | The name of the base platform stack. |
7843
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtensionProps.property.redirectUri">redirectUri</a></code> | <code>string</code> | Adds OIDC_REDIRECT_URI environment variable to the container if set. |
7844
+
7845
+ ---
7846
+
7847
+ ##### `platformStackName`<sup>Required</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.OpenIdExtensionProps.property.platformStackName"></a>
7848
+
7849
+ ```typescript
7850
+ public readonly platformStackName: string;
7851
+ ```
7852
+
7853
+ - *Type:* string
7854
+
7855
+ The name of the base platform stack.
7856
+
7857
+ ---
7858
+
7859
+ ##### `redirectUri`<sup>Optional</sup> <a name="redirectUri" id="@btc-embedded/cdk-extensions.OpenIdExtensionProps.property.redirectUri"></a>
7860
+
7861
+ ```typescript
7862
+ public readonly redirectUri: string;
7863
+ ```
7864
+
7865
+ - *Type:* string
7866
+
7867
+ Adds OIDC_REDIRECT_URI environment variable to the container if set.
7868
+
7869
+ ---
7870
+
7741
7871
  ### OpenTelemetryExtensionProps <a name="OpenTelemetryExtensionProps" id="@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps"></a>
7742
7872
 
7743
7873
  #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps.Initializer"></a>
@@ -9398,8 +9528,6 @@ The created task definition to add containers to.
9398
9528
  | --- | --- | --- |
9399
9529
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionV2.property.name">name</a></code> | <code>string</code> | The name of the extension. |
9400
9530
  | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionV2.property.container">container</a></code> | <code>aws-cdk-lib.aws_ecs.ContainerDefinition</code> | The container for this extension. |
9401
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionV2.property.cognitoUserPool">cognitoUserPool</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool">ICognitoUserPool</a></code> | *No description.* |
9402
- | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionV2.property.fqdn">fqdn</a></code> | <code>string</code> | *No description.* |
9403
9531
 
9404
9532
  ---
9405
9533
 
@@ -9432,26 +9560,6 @@ connected to the service.
9432
9560
 
9433
9561
  ---
9434
9562
 
9435
- ##### `cognitoUserPool`<sup>Required</sup> <a name="cognitoUserPool" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionV2.property.cognitoUserPool"></a>
9436
-
9437
- ```typescript
9438
- public readonly cognitoUserPool: ICognitoUserPool;
9439
- ```
9440
-
9441
- - *Type:* <a href="#@btc-embedded/cdk-extensions.ICognitoUserPool">ICognitoUserPool</a>
9442
-
9443
- ---
9444
-
9445
- ##### `fqdn`<sup>Required</sup> <a name="fqdn" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtensionV2.property.fqdn"></a>
9446
-
9447
- ```typescript
9448
- public readonly fqdn: string;
9449
- ```
9450
-
9451
- - *Type:* string
9452
-
9453
- ---
9454
-
9455
9563
 
9456
9564
  ### CloudMapExtension <a name="CloudMapExtension" id="@btc-embedded/cdk-extensions.CloudMapExtension"></a>
9457
9565
 
@@ -12041,6 +12149,248 @@ public readonly props: TaskDefinitionProps;
12041
12149
  ---
12042
12150
 
12043
12151
 
12152
+ ### OpenIdExtension <a name="OpenIdExtension" id="@btc-embedded/cdk-extensions.OpenIdExtension"></a>
12153
+
12154
+ #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.OpenIdExtension.Initializer"></a>
12155
+
12156
+ ```typescript
12157
+ import { OpenIdExtension } from '@btc-embedded/cdk-extensions'
12158
+
12159
+ new OpenIdExtension(props: OpenIdExtensionProps)
12160
+ ```
12161
+
12162
+ | **Name** | **Type** | **Description** |
12163
+ | --- | --- | --- |
12164
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtensionProps">OpenIdExtensionProps</a></code> | *No description.* |
12165
+
12166
+ ---
12167
+
12168
+ ##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.OpenIdExtension.Initializer.parameter.props"></a>
12169
+
12170
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.OpenIdExtensionProps">OpenIdExtensionProps</a>
12171
+
12172
+ ---
12173
+
12174
+ #### Methods <a name="Methods" id="Methods"></a>
12175
+
12176
+ | **Name** | **Description** |
12177
+ | --- | --- |
12178
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.addContainerMutatingHook">addContainerMutatingHook</a></code> | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. |
12179
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.addHooks">addHooks</a></code> | A hook that allows the extension to add hooks to other extensions that are registered. |
12180
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.connectToService">connectToService</a></code> | This hook allows the extension to establish a connection to extensions from another service. |
12181
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.modifyServiceProps">modifyServiceProps</a></code> | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. |
12182
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.modifyTaskDefinitionProps">modifyTaskDefinitionProps</a></code> | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. |
12183
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.prehook">prehook</a></code> | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. |
12184
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.resolveContainerDependencies">resolveContainerDependencies</a></code> | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. |
12185
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.useService">useService</a></code> | When this hook is implemented by extension, it allows the extension to use the service which has been created. |
12186
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.useTaskDefinition">useTaskDefinition</a></code> | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. |
12187
+
12188
+ ---
12189
+
12190
+ ##### `addContainerMutatingHook` <a name="addContainerMutatingHook" id="@btc-embedded/cdk-extensions.OpenIdExtension.addContainerMutatingHook"></a>
12191
+
12192
+ ```typescript
12193
+ public addContainerMutatingHook(hook: ContainerMutatingHook): void
12194
+ ```
12195
+
12196
+ This hook allows another service extension to register a mutating hook for changing the primary container of this extension.
12197
+
12198
+ This is primarily used
12199
+ for the application extension. For example, the Firelens extension wants to
12200
+ be able to modify the settings of the application container to
12201
+ route logs through Firelens.
12202
+
12203
+ ###### `hook`<sup>Required</sup> <a name="hook" id="@btc-embedded/cdk-extensions.OpenIdExtension.addContainerMutatingHook.parameter.hook"></a>
12204
+
12205
+ - *Type:* @aws-cdk-containers/ecs-service-extensions.ContainerMutatingHook
12206
+
12207
+ ---
12208
+
12209
+ ##### `addHooks` <a name="addHooks" id="@btc-embedded/cdk-extensions.OpenIdExtension.addHooks"></a>
12210
+
12211
+ ```typescript
12212
+ public addHooks(): void
12213
+ ```
12214
+
12215
+ A hook that allows the extension to add hooks to other extensions that are registered.
12216
+
12217
+ ##### `connectToService` <a name="connectToService" id="@btc-embedded/cdk-extensions.OpenIdExtension.connectToService"></a>
12218
+
12219
+ ```typescript
12220
+ public connectToService(service: Service, connectToProps?: ConnectToProps): void
12221
+ ```
12222
+
12223
+ This hook allows the extension to establish a connection to extensions from another service.
12224
+
12225
+ Usually used for things like
12226
+ allowing one service to talk to the load balancer or service mesh
12227
+ proxy for another service.
12228
+
12229
+ ###### `service`<sup>Required</sup> <a name="service" id="@btc-embedded/cdk-extensions.OpenIdExtension.connectToService.parameter.service"></a>
12230
+
12231
+ - *Type:* @aws-cdk-containers/ecs-service-extensions.Service
12232
+
12233
+ The other service to connect to.
12234
+
12235
+ ---
12236
+
12237
+ ###### `connectToProps`<sup>Optional</sup> <a name="connectToProps" id="@btc-embedded/cdk-extensions.OpenIdExtension.connectToService.parameter.connectToProps"></a>
12238
+
12239
+ - *Type:* @aws-cdk-containers/ecs-service-extensions.ConnectToProps
12240
+
12241
+ ---
12242
+
12243
+ ##### `modifyServiceProps` <a name="modifyServiceProps" id="@btc-embedded/cdk-extensions.OpenIdExtension.modifyServiceProps"></a>
12244
+
12245
+ ```typescript
12246
+ public modifyServiceProps(props: ServiceBuild): ServiceBuild
12247
+ ```
12248
+
12249
+ Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created.
12250
+
12251
+ ###### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.OpenIdExtension.modifyServiceProps.parameter.props"></a>
12252
+
12253
+ - *Type:* @aws-cdk-containers/ecs-service-extensions.ServiceBuild
12254
+
12255
+ The service properties to mutate.
12256
+
12257
+ ---
12258
+
12259
+ ##### `modifyTaskDefinitionProps` <a name="modifyTaskDefinitionProps" id="@btc-embedded/cdk-extensions.OpenIdExtension.modifyTaskDefinitionProps"></a>
12260
+
12261
+ ```typescript
12262
+ public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps
12263
+ ```
12264
+
12265
+ This is a hook which allows extensions to modify the settings of the task definition prior to it being created.
12266
+
12267
+ For example, the App Mesh
12268
+ extension needs to configure an Envoy proxy in the task definition,
12269
+ or the Application extension wants to set the overall resource for
12270
+ the task.
12271
+
12272
+ ###### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.OpenIdExtension.modifyTaskDefinitionProps.parameter.props"></a>
12273
+
12274
+ - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps
12275
+
12276
+ Properties of the task definition to be created.
12277
+
12278
+ ---
12279
+
12280
+ ##### `prehook` <a name="prehook" id="@btc-embedded/cdk-extensions.OpenIdExtension.prehook"></a>
12281
+
12282
+ ```typescript
12283
+ public prehook(service: Service, _scope: Construct): void
12284
+ ```
12285
+
12286
+ A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance.
12287
+
12288
+ ###### `service`<sup>Required</sup> <a name="service" id="@btc-embedded/cdk-extensions.OpenIdExtension.prehook.parameter.service"></a>
12289
+
12290
+ - *Type:* @aws-cdk-containers/ecs-service-extensions.Service
12291
+
12292
+ ---
12293
+
12294
+ ###### `_scope`<sup>Required</sup> <a name="_scope" id="@btc-embedded/cdk-extensions.OpenIdExtension.prehook.parameter._scope"></a>
12295
+
12296
+ - *Type:* constructs.Construct
12297
+
12298
+ ---
12299
+
12300
+ ##### `resolveContainerDependencies` <a name="resolveContainerDependencies" id="@btc-embedded/cdk-extensions.OpenIdExtension.resolveContainerDependencies"></a>
12301
+
12302
+ ```typescript
12303
+ public resolveContainerDependencies(): void
12304
+ ```
12305
+
12306
+ Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled.
12307
+
12308
+ ##### `useService` <a name="useService" id="@btc-embedded/cdk-extensions.OpenIdExtension.useService"></a>
12309
+
12310
+ ```typescript
12311
+ public useService(service: Ec2Service | FargateService): void
12312
+ ```
12313
+
12314
+ When this hook is implemented by extension, it allows the extension to use the service which has been created.
12315
+
12316
+ It is generally used to
12317
+ create any final resources which might depend on the service itself.
12318
+
12319
+ ###### `service`<sup>Required</sup> <a name="service" id="@btc-embedded/cdk-extensions.OpenIdExtension.useService.parameter.service"></a>
12320
+
12321
+ - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService
12322
+
12323
+ The generated service.
12324
+
12325
+ ---
12326
+
12327
+ ##### `useTaskDefinition` <a name="useTaskDefinition" id="@btc-embedded/cdk-extensions.OpenIdExtension.useTaskDefinition"></a>
12328
+
12329
+ ```typescript
12330
+ public useTaskDefinition(taskDefinition: TaskDefinition): void
12331
+ ```
12332
+
12333
+ Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc.
12334
+
12335
+ ###### `taskDefinition`<sup>Required</sup> <a name="taskDefinition" id="@btc-embedded/cdk-extensions.OpenIdExtension.useTaskDefinition.parameter.taskDefinition"></a>
12336
+
12337
+ - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition
12338
+
12339
+ The created task definition to add containers to.
12340
+
12341
+ ---
12342
+
12343
+
12344
+ #### Properties <a name="Properties" id="Properties"></a>
12345
+
12346
+ | **Name** | **Type** | **Description** |
12347
+ | --- | --- | --- |
12348
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.property.name">name</a></code> | <code>string</code> | The name of the extension. |
12349
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.property.container">container</a></code> | <code>aws-cdk-lib.aws_ecs.ContainerDefinition</code> | The container for this extension. |
12350
+ | <code><a href="#@btc-embedded/cdk-extensions.OpenIdExtension.property.cognitoUserPool">cognitoUserPool</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool">ICognitoUserPool</a></code> | *No description.* |
12351
+
12352
+ ---
12353
+
12354
+ ##### `name`<sup>Required</sup> <a name="name" id="@btc-embedded/cdk-extensions.OpenIdExtension.property.name"></a>
12355
+
12356
+ ```typescript
12357
+ public readonly name: string;
12358
+ ```
12359
+
12360
+ - *Type:* string
12361
+
12362
+ The name of the extension.
12363
+
12364
+ ---
12365
+
12366
+ ##### `container`<sup>Optional</sup> <a name="container" id="@btc-embedded/cdk-extensions.OpenIdExtension.property.container"></a>
12367
+
12368
+ ```typescript
12369
+ public readonly container: ContainerDefinition;
12370
+ ```
12371
+
12372
+ - *Type:* aws-cdk-lib.aws_ecs.ContainerDefinition
12373
+
12374
+ The container for this extension.
12375
+
12376
+ Most extensions have a container, but not
12377
+ every extension is required to have a container. Some extensions may just
12378
+ modify the properties of the service, or create external resources
12379
+ connected to the service.
12380
+
12381
+ ---
12382
+
12383
+ ##### `cognitoUserPool`<sup>Required</sup> <a name="cognitoUserPool" id="@btc-embedded/cdk-extensions.OpenIdExtension.property.cognitoUserPool"></a>
12384
+
12385
+ ```typescript
12386
+ public readonly cognitoUserPool: ICognitoUserPool;
12387
+ ```
12388
+
12389
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.ICognitoUserPool">ICognitoUserPool</a>
12390
+
12391
+ ---
12392
+
12393
+
12044
12394
  ### OpenTelemetryExtension <a name="OpenTelemetryExtension" id="@btc-embedded/cdk-extensions.OpenTelemetryExtension"></a>
12045
12395
 
12046
12396
  Adds the OpenTelemetry collector as a sidecar to the ECS task.
@@ -13233,10 +13583,21 @@ public addTarget(target: IApplicationLoadBalancerTarget): void
13233
13583
 
13234
13584
  | **Name** | **Type** | **Description** |
13235
13585
  | --- | --- | --- |
13586
+ | <code><a href="#@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
13236
13587
  | <code><a href="#@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2.property.targetGroup">targetGroup</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup</code> | *No description.* |
13237
13588
 
13238
13589
  ---
13239
13590
 
13591
+ ##### `domainName`<sup>Required</sup> <a name="domainName" id="@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2.property.domainName"></a>
13592
+
13593
+ ```typescript
13594
+ public readonly domainName: string;
13595
+ ```
13596
+
13597
+ - *Type:* string
13598
+
13599
+ ---
13600
+
13240
13601
  ##### `targetGroup`<sup>Required</sup> <a name="targetGroup" id="@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2.property.targetGroup"></a>
13241
13602
 
13242
13603
  ```typescript
@@ -13277,6 +13638,7 @@ public createHttpUserPoolAuthorizer(): HttpUserPoolAuthorizer
13277
13638
  | **Name** | **Type** | **Description** |
13278
13639
  | --- | --- | --- |
13279
13640
  | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool.property.apiUserPoolClient">apiUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
13641
+ | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool.property.appOpenIdParameters">appOpenIdParameters</a></code> | <code><a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters">AppOpenIdParameters</a></code> | Contains the OpenID parameters of the frontend/web application client. |
13280
13642
  | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool.property.appUserPoolClient">appUserPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
13281
13643
  | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool.property.cognitoUserPoolDomain">cognitoUserPoolDomain</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolDomain</code> | *No description.* |
13282
13644
  | <code><a href="#@btc-embedded/cdk-extensions.ICognitoUserPool.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | *No description.* |
@@ -13293,6 +13655,18 @@ public readonly apiUserPoolClient: IUserPoolClient;
13293
13655
 
13294
13656
  ---
13295
13657
 
13658
+ ##### `appOpenIdParameters`<sup>Required</sup> <a name="appOpenIdParameters" id="@btc-embedded/cdk-extensions.ICognitoUserPool.property.appOpenIdParameters"></a>
13659
+
13660
+ ```typescript
13661
+ public readonly appOpenIdParameters: AppOpenIdParameters;
13662
+ ```
13663
+
13664
+ - *Type:* <a href="#@btc-embedded/cdk-extensions.AppOpenIdParameters">AppOpenIdParameters</a>
13665
+
13666
+ Contains the OpenID parameters of the frontend/web application client.
13667
+
13668
+ ---
13669
+
13296
13670
  ##### `appUserPoolClient`<sup>Required</sup> <a name="appUserPoolClient" id="@btc-embedded/cdk-extensions.ICognitoUserPool.property.appUserPoolClient"></a>
13297
13671
 
13298
13672
  ```typescript
package/CHANGELOG.md CHANGED
@@ -1,4 +1,11 @@
1
1
 
2
+ ## [0.18.1](https://github.com/btc-embedded/cdk-extensions/compare/v0.18.0...v0.18.1) (2026-01-14)
3
+
4
+
5
+ ### Features
6
+
7
+ * ALB extension v2 is not dependent to the baseplatform alb ([7a5a642](https://github.com/btc-embedded/cdk-extensions/commit/7a5a6421a81b38aa317ab471c828c47ca86bdb28))
8
+
2
9
  ## [0.18.0](https://github.com/btc-embedded/cdk-extensions/compare/v0.17.1...v0.18.0) (2026-01-13)
3
10
 
4
11