@btc-embedded/cdk-extensions 0.1.1 → 0.3.0

package/API.md

@@ -1,55 +1,735 @@
 # API Reference <a name="API Reference" id="api-reference"></a>
 
+## Constructs <a name="Constructs" id="Constructs"></a>
+
+### ApiGateway <a name="ApiGateway" id="@btc-embedded/cdk-extensions.ApiGateway"></a>
+
+API Gateway construct to be used in base platforms.
+
+This API Gateway construct sets up an API Gateway V2 and a default HTTP API
+protected by the provided Cognito user pool and client(s). The construct
+registers an A record for the subdomain in the provided hosted zone. It also
+creates a VPC Link (and security group) for the API Gateway to connect to
+services in the VPC.
+
+The relevant parameters are exposed as CloudFormation outputs so that they
+can be used by the CDK extensions provided in this library.
+
+#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGateway.Initializer"></a>
+
+```typescript
+import { ApiGateway } from '@btc-embedded/cdk-extensions'
+
+new ApiGateway(scope: Construct, id: string, props: ApiGatewayProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGateway.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGateway.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGateway.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps">ApiGatewayProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApiGateway.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApiGateway.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.ApiGateway.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.ApiGatewayProps">ApiGatewayProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGateway.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.ApiGateway.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGateway.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApiGateway.isConstruct"></a>
+
+```typescript
+import { ApiGateway } from '@btc-embedded/cdk-extensions'
+
+ApiGateway.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.ApiGateway.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGateway.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.ApiGateway.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+
+### ApplicationLoadBalancer <a name="ApplicationLoadBalancer" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer"></a>
+
+#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.Initializer"></a>
+
+```typescript
+import { ApplicationLoadBalancer } from '@btc-embedded/cdk-extensions'
+
+new ApplicationLoadBalancer(scope: Construct, id: string, props: ApplicationLoadBalancerProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps">ApplicationLoadBalancerProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps">ApplicationLoadBalancerProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.isConstruct"></a>
+
+```typescript
+import { ApplicationLoadBalancer } from '@btc-embedded/cdk-extensions'
+
+ApplicationLoadBalancer.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.property.loadbalancer">loadbalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancer.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer</code> | *No description.* |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `loadbalancer`<sup>Required</sup> <a name="loadbalancer" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.property.loadbalancer"></a>
+
+```typescript
+public readonly loadbalancer: ApplicationLoadBalancer;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer
+
+---
+
+##### `loadBalancer`<sup>Required</sup> <a name="loadBalancer" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancer.property.loadBalancer"></a>
+
+```typescript
+public readonly loadBalancer: IApplicationLoadBalancer;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer
+
+---
+
+
+### CloudMap <a name="CloudMap" id="@btc-embedded/cdk-extensions.CloudMap"></a>
+
+#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.CloudMap.Initializer"></a>
+
+```typescript
+import { CloudMap } from '@btc-embedded/cdk-extensions'
+
+new CloudMap(scope: Construct, id: string, props: CloudMapProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMap.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMap.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMap.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.CloudMapProps">CloudMapProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.CloudMap.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.CloudMap.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.CloudMap.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.CloudMapProps">CloudMapProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMap.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.CloudMap.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMap.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@btc-embedded/cdk-extensions.CloudMap.isConstruct"></a>
+
+```typescript
+import { CloudMap } from '@btc-embedded/cdk-extensions'
+
+CloudMap.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.CloudMap.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMap.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMap.property.namespace">namespace</a></code> | <code>aws-cdk-lib.aws_servicediscovery.PrivateDnsNamespace</code> | *No description.* |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.CloudMap.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `namespace`<sup>Required</sup> <a name="namespace" id="@btc-embedded/cdk-extensions.CloudMap.property.namespace"></a>
+
+```typescript
+public readonly namespace: PrivateDnsNamespace;
+```
+
+- *Type:* aws-cdk-lib.aws_servicediscovery.PrivateDnsNamespace
+
+---
+
+
+### DefaultUserPoolClients <a name="DefaultUserPoolClients" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients"></a>
+
+Create default user pool clients for the frontend and API access.
+
+#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.Initializer"></a>
+
+```typescript
+import { DefaultUserPoolClients } from '@btc-embedded/cdk-extensions'
+
+new DefaultUserPoolClients(scope: Construct, id: string, props: DefaultUserPoolClientsProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps">DefaultUserPoolClientsProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps">DefaultUserPoolClientsProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.isConstruct"></a>
+
+```typescript
+import { DefaultUserPoolClients } from '@btc-embedded/cdk-extensions'
+
+DefaultUserPoolClients.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.property.apiClient">apiClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClients.property.frontendClient">frontendClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `apiClient`<sup>Required</sup> <a name="apiClient" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.property.apiClient"></a>
+
+```typescript
+public readonly apiClient: IUserPoolClient;
+```
+
+- *Type:* aws-cdk-lib.aws_cognito.IUserPoolClient
+
+---
+
+##### `frontendClient`<sup>Required</sup> <a name="frontendClient" id="@btc-embedded/cdk-extensions.DefaultUserPoolClients.property.frontendClient"></a>
+
+```typescript
+public readonly frontendClient: IUserPoolClient;
+```
+
+- *Type:* aws-cdk-lib.aws_cognito.IUserPoolClient
+
+---
+
+
+### DocumentDB <a name="DocumentDB" id="@btc-embedded/cdk-extensions.DocumentDB"></a>
+
+#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.DocumentDB.Initializer"></a>
+
+```typescript
+import { DocumentDB } from '@btc-embedded/cdk-extensions'
+
+new DocumentDB(scope: Construct, id: string, props: DocumentDBProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDB.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDB.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDB.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.DocumentDBProps">DocumentDBProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.DocumentDB.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.DocumentDB.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.DocumentDB.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.DocumentDBProps">DocumentDBProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDB.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.DocumentDB.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDB.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@btc-embedded/cdk-extensions.DocumentDB.isConstruct"></a>
+
+```typescript
+import { DocumentDB } from '@btc-embedded/cdk-extensions'
+
+DocumentDB.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.DocumentDB.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDB.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.DocumentDB.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
 
 ## Structs <a name="Structs" id="Structs"></a>
 
 ### ApiGatewayExtensionProps <a name="ApiGatewayExtensionProps" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps"></a>
 
-#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.Initializer"></a>
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.Initializer"></a>
+
+```typescript
+import { ApiGatewayExtensionProps } from '@btc-embedded/cdk-extensions'
+
+const apiGatewayExtensionProps: ApiGatewayExtensionProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.platformStackName">platformStackName</a></code> | <code>string</code> | The name of the base platform stack. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.prefix">prefix</a></code> | <code>string</code> | The prefix for the API Gateway endpoint. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.securityGroupId">securityGroupId</a></code> | <code>string</code> | The security group ID of the API Gateway which should be allowed to connect to the service. |
+
+---
+
+##### `platformStackName`<sup>Required</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.platformStackName"></a>
+
+```typescript
+public readonly platformStackName: string;
+```
+
+- *Type:* string
+
+The name of the base platform stack.
+
+---
+
+##### `prefix`<sup>Required</sup> <a name="prefix" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.prefix"></a>
+
+```typescript
+public readonly prefix: string;
+```
+
+- *Type:* string
+
+The prefix for the API Gateway endpoint.
+
+---
+
+##### `securityGroupId`<sup>Required</sup> <a name="securityGroupId" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.securityGroupId"></a>
+
+```typescript
+public readonly securityGroupId: string;
+```
+
+- *Type:* string
+
+The security group ID of the API Gateway which should be allowed to connect to the service.
+
+---
+
+### ApiGatewayProps <a name="ApiGatewayProps" id="@btc-embedded/cdk-extensions.ApiGatewayProps"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApiGatewayProps.Initializer"></a>
+
+```typescript
+import { ApiGatewayProps } from '@btc-embedded/cdk-extensions'
+
+const apiGatewayProps: ApiGatewayProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps.property.domainPrefix">domainPrefix</a></code> | <code>string</code> | Domain prefix for the API Gateway endpoint. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps.property.hostedZone">hostedZone</a></code> | <code>aws-cdk-lib.aws_route53.IHostedZone</code> | Hosted Zone where the A record for the domain will be created. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps.property.stackName">stackName</a></code> | <code>string</code> | The name of the stack, used for prefixing the output parameter names. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | Specify the Cognito User Pool to be used for authorizing requests on the API Gateway. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps.property.userPoolClients">userPoolClients</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient[]</code> | List of User Pool Clients that are allowed to access the API Gateway. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC where the API GW Security group and VPC Link will be created. |
+| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayProps.property.enableAccessLogs">enableAccessLogs</a></code> | <code>boolean</code> | Enable access logs for the API Gateway. |
+
+---
+
+##### `domainPrefix`<sup>Required</sup> <a name="domainPrefix" id="@btc-embedded/cdk-extensions.ApiGatewayProps.property.domainPrefix"></a>
+
+```typescript
+public readonly domainPrefix: string;
+```
+
+- *Type:* string
+
+Domain prefix for the API Gateway endpoint.
+
+---
+
+##### `hostedZone`<sup>Required</sup> <a name="hostedZone" id="@btc-embedded/cdk-extensions.ApiGatewayProps.property.hostedZone"></a>
+
+```typescript
+public readonly hostedZone: IHostedZone;
+```
+
+- *Type:* aws-cdk-lib.aws_route53.IHostedZone
+
+Hosted Zone where the A record for the domain will be created.
+
+---
+
+##### `stackName`<sup>Required</sup> <a name="stackName" id="@btc-embedded/cdk-extensions.ApiGatewayProps.property.stackName"></a>
 
 ```typescript
-import { ApiGatewayExtensionProps } from '@btc-embedded/cdk-extensions'
+public readonly stackName: string;
+```
 
-const apiGatewayExtensionProps: ApiGatewayExtensionProps = { ... }
+- *Type:* string
+
+The name of the stack, used for prefixing the output parameter names.
+
+---
+
+##### `userPool`<sup>Required</sup> <a name="userPool" id="@btc-embedded/cdk-extensions.ApiGatewayProps.property.userPool"></a>
+
+```typescript
+public readonly userPool: IUserPool;
 ```
 
-#### Properties <a name="Properties" id="Properties"></a>
+- *Type:* aws-cdk-lib.aws_cognito.IUserPool
 
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.platformStackName">platformStackName</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.prefix">prefix</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.securityGroupId">securityGroupId</a></code> | <code>string</code> | *No description.* |
+Specify the Cognito User Pool to be used for authorizing requests on the API Gateway.
 
 ---
 
-##### `platformStackName`<sup>Required</sup> <a name="platformStackName" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.platformStackName"></a>
+##### `userPoolClients`<sup>Required</sup> <a name="userPoolClients" id="@btc-embedded/cdk-extensions.ApiGatewayProps.property.userPoolClients"></a>
 
 ```typescript
-public readonly platformStackName: string;
+public readonly userPoolClients: IUserPoolClient[];
 ```
 
-- *Type:* string
+- *Type:* aws-cdk-lib.aws_cognito.IUserPoolClient[]
+
+List of User Pool Clients that are allowed to access the API Gateway.
 
 ---
 
-##### `prefix`<sup>Required</sup> <a name="prefix" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.prefix"></a>
+##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApiGatewayProps.property.vpc"></a>
 
 ```typescript
-public readonly prefix: string;
+public readonly vpc: IVpc;
 ```
 
-- *Type:* string
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+
+VPC where the API GW Security group and VPC Link will be created.
 
 ---
 
-##### `securityGroupId`<sup>Required</sup> <a name="securityGroupId" id="@btc-embedded/cdk-extensions.ApiGatewayExtensionProps.property.securityGroupId"></a>
+##### `enableAccessLogs`<sup>Optional</sup> <a name="enableAccessLogs" id="@btc-embedded/cdk-extensions.ApiGatewayProps.property.enableAccessLogs"></a>
 
 ```typescript
-public readonly securityGroupId: string;
+public readonly enableAccessLogs: boolean;
 ```
 
-- *Type:* string
+- *Type:* boolean
+
+Enable access logs for the API Gateway.
+
+default: true
 
 ---
 
@@ -136,6 +816,78 @@ public readonly path: string;
 
 ---
 
+### ApplicationLoadBalancerProps <a name="ApplicationLoadBalancerProps" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.Initializer"></a>
+
+```typescript
+import { ApplicationLoadBalancerProps } from '@btc-embedded/cdk-extensions'
+
+const applicationLoadBalancerProps: ApplicationLoadBalancerProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.fqdn">fqdn</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.userPoolClient">userPoolClient</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolClient</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.userPoolDomain">userPoolDomain</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPoolDomain</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
+
+---
+
+##### `fqdn`<sup>Required</sup> <a name="fqdn" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.fqdn"></a>
+
+```typescript
+public readonly fqdn: string;
+```
+
+- *Type:* string
+
+---
+
+##### `userPool`<sup>Required</sup> <a name="userPool" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.userPool"></a>
+
+```typescript
+public readonly userPool: IUserPool;
+```
+
+- *Type:* aws-cdk-lib.aws_cognito.IUserPool
+
+---
+
+##### `userPoolClient`<sup>Required</sup> <a name="userPoolClient" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.userPoolClient"></a>
+
+```typescript
+public readonly userPoolClient: IUserPoolClient;
+```
+
+- *Type:* aws-cdk-lib.aws_cognito.IUserPoolClient
+
+---
+
+##### `userPoolDomain`<sup>Required</sup> <a name="userPoolDomain" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.userPoolDomain"></a>
+
+```typescript
+public readonly userPoolDomain: IUserPoolDomain;
+```
+
+- *Type:* aws-cdk-lib.aws_cognito.IUserPoolDomain
+
+---
+
+##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps.property.vpc"></a>
+
+```typescript
+public readonly vpc: IVpc;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+
+---
+
 ### CloudMapExtensionProps <a name="CloudMapExtensionProps" id="@btc-embedded/cdk-extensions.CloudMapExtensionProps"></a>
 
 #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.CloudMapExtensionProps.Initializer"></a>
@@ -164,6 +916,45 @@ public readonly platformStackName: string;
 
 ---
 
+### CloudMapProps <a name="CloudMapProps" id="@btc-embedded/cdk-extensions.CloudMapProps"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.CloudMapProps.Initializer"></a>
+
+```typescript
+import { CloudMapProps } from '@btc-embedded/cdk-extensions'
+
+const cloudMapProps: CloudMapProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMapProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.CloudMapProps.property.privateDnsNamespace">privateDnsNamespace</a></code> | <code><a href="#@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps">PrivateDnsNamespaceProps</a></code> | *No description.* |
+
+---
+
+##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.CloudMapProps.property.vpc"></a>
+
+```typescript
+public readonly vpc: IVpc;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+
+---
+
+##### `privateDnsNamespace`<sup>Optional</sup> <a name="privateDnsNamespace" id="@btc-embedded/cdk-extensions.CloudMapProps.property.privateDnsNamespace"></a>
+
+```typescript
+public readonly privateDnsNamespace: PrivateDnsNamespaceProps;
+```
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps">PrivateDnsNamespaceProps</a>
+
+---
+
 ### ContainerProps <a name="ContainerProps" id="@btc-embedded/cdk-extensions.ContainerProps"></a>
 
 #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.ContainerProps.Initializer"></a>
@@ -795,6 +1586,67 @@ The log group into which application container logs should be routed.
 
 ---
 
+### DefaultUserPoolClientsProps <a name="DefaultUserPoolClientsProps" id="@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.Initializer"></a>
+
+```typescript
+import { DefaultUserPoolClientsProps } from '@btc-embedded/cdk-extensions'
+
+const defaultUserPoolClientsProps: DefaultUserPoolClientsProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.callbackUrls">callbackUrls</a></code> | <code>string[]</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.fqdn">fqdn</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.logoutUrls">logoutUrls</a></code> | <code>string[]</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.userPool">userPool</a></code> | <code>aws-cdk-lib.aws_cognito.IUserPool</code> | *No description.* |
+
+---
+
+##### `callbackUrls`<sup>Required</sup> <a name="callbackUrls" id="@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.callbackUrls"></a>
+
+```typescript
+public readonly callbackUrls: string[];
+```
+
+- *Type:* string[]
+
+---
+
+##### `fqdn`<sup>Required</sup> <a name="fqdn" id="@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.fqdn"></a>
+
+```typescript
+public readonly fqdn: string;
+```
+
+- *Type:* string
+
+---
+
+##### `logoutUrls`<sup>Required</sup> <a name="logoutUrls" id="@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.logoutUrls"></a>
+
+```typescript
+public readonly logoutUrls: string[];
+```
+
+- *Type:* string[]
+
+---
+
+##### `userPool`<sup>Required</sup> <a name="userPool" id="@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps.property.userPool"></a>
+
+```typescript
+public readonly userPool: IUserPool;
+```
+
+- *Type:* aws-cdk-lib.aws_cognito.IUserPool
+
+---
+
 ### DocumentDbAccessExtensionProps <a name="DocumentDbAccessExtensionProps" id="@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps"></a>
 
 #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps.Initializer"></a>
@@ -809,15 +1661,15 @@ const documentDbAccessExtensionProps: DocumentDbAccessExtensionProps = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps.property.secretArn">secretArn</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps.property.basePlatformStackName">basePlatformStackName</a></code> | <code>string</code> | *No description.* |
 | <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps.property.securityGroupId">securityGroupId</a></code> | <code>string</code> | *No description.* |
 
 ---
 
-##### `secretArn`<sup>Required</sup> <a name="secretArn" id="@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps.property.secretArn"></a>
+##### `basePlatformStackName`<sup>Required</sup> <a name="basePlatformStackName" id="@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps.property.basePlatformStackName"></a>
 
 ```typescript
-public readonly secretArn: string;
+public readonly basePlatformStackName: string;
 ```
 
 - *Type:* string
@@ -834,6 +1686,67 @@ public readonly securityGroupId: string;
 
 ---
 
+### DocumentDBProps <a name="DocumentDBProps" id="@btc-embedded/cdk-extensions.DocumentDBProps"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.DocumentDBProps.Initializer"></a>
+
+```typescript
+import { DocumentDBProps } from '@btc-embedded/cdk-extensions'
+
+const documentDBProps: DocumentDBProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDBProps.property.secretName">secretName</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDBProps.property.stackName">stackName</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDBProps.property.username">username</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDBProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
+
+---
+
+##### `secretName`<sup>Required</sup> <a name="secretName" id="@btc-embedded/cdk-extensions.DocumentDBProps.property.secretName"></a>
+
+```typescript
+public readonly secretName: string;
+```
+
+- *Type:* string
+
+---
+
+##### `stackName`<sup>Required</sup> <a name="stackName" id="@btc-embedded/cdk-extensions.DocumentDBProps.property.stackName"></a>
+
+```typescript
+public readonly stackName: string;
+```
+
+- *Type:* string
+
+---
+
+##### `username`<sup>Required</sup> <a name="username" id="@btc-embedded/cdk-extensions.DocumentDBProps.property.username"></a>
+
+```typescript
+public readonly username: string;
+```
+
+- *Type:* string
+
+---
+
+##### `vpc`<sup>Required</sup> <a name="vpc" id="@btc-embedded/cdk-extensions.DocumentDBProps.property.vpc"></a>
+
+```typescript
+public readonly vpc: IVpc;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+
+---
+
 ### EventListenerExtensionProps <a name="EventListenerExtensionProps" id="@btc-embedded/cdk-extensions.EventListenerExtensionProps"></a>
 
 #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.EventListenerExtensionProps.Initializer"></a>
@@ -916,6 +1829,56 @@ Defaults to ContainerDependencyCondition.HEALTHY.
 
 ---
 
+### PrivateDnsNamespaceProps <a name="PrivateDnsNamespaceProps" id="@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps.Initializer"></a>
+
+```typescript
+import { PrivateDnsNamespaceProps } from '@btc-embedded/cdk-extensions'
+
+const privateDnsNamespaceProps: PrivateDnsNamespaceProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps.property.arn">arn</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps.property.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps.property.namespace">namespace</a></code> | <code>string</code> | *No description.* |
+
+---
+
+##### `arn`<sup>Required</sup> <a name="arn" id="@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps.property.arn"></a>
+
+```typescript
+public readonly arn: string;
+```
+
+- *Type:* string
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps.property.id"></a>
+
+```typescript
+public readonly id: string;
+```
+
+- *Type:* string
+
+---
+
+##### `namespace`<sup>Required</sup> <a name="namespace" id="@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps.property.namespace"></a>
+
+```typescript
+public readonly namespace: string;
+```
+
+- *Type:* string
+
+---
+
 ### TcpKeepAliveExtensionProps <a name="TcpKeepAliveExtensionProps" id="@btc-embedded/cdk-extensions.TcpKeepAliveExtensionProps"></a>
 
 #### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.TcpKeepAliveExtensionProps.Initializer"></a>
@@ -970,6 +1933,8 @@ public readonly time: number;
 
 ### ApiGatewayExtension <a name="ApiGatewayExtension" id="@btc-embedded/cdk-extensions.ApiGatewayExtension"></a>
 
+Configures the service to be reachable via an API Gateway.
+
 #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.ApiGatewayExtension.Initializer"></a>
 
 ```typescript
@@ -1859,16 +2824,12 @@ A hook that is called for each extension ahead of time to allow for any initial
 
 - *Type:* @aws-cdk-containers/ecs-service-extensions.Service
 
-The parent service which this extension has been added to.
-
 ---
 
 ###### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.DocumentDbAccessExtension.prehook.parameter.scope"></a>
 
 - *Type:* constructs.Construct
 
-The scope that this extension should create resources in.
-
 ---
 
 ##### `resolveContainerDependencies` <a name="resolveContainerDependencies" id="@btc-embedded/cdk-extensions.DocumentDbAccessExtension.resolveContainerDependencies"></a>
@@ -1920,6 +2881,7 @@ The created task definition to add containers to.
 | <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtension.property.name">name</a></code> | <code>string</code> | The name of the extension. |
 | <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtension.property.container">container</a></code> | <code>aws-cdk-lib.aws_ecs.ContainerDefinition</code> | The container for this extension. |
 | <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtension.property.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps">DocumentDbAccessExtensionProps</a></code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.DocumentDbAccessExtension.property.secretArn">secretArn</a></code> | <code>string</code> | *No description.* |
 
 ---
 
@@ -1962,6 +2924,16 @@ public readonly props: DocumentDbAccessExtensionProps;
 
 ---
 
+##### `secretArn`<sup>Required</sup> <a name="secretArn" id="@btc-embedded/cdk-extensions.DocumentDbAccessExtension.property.secretArn"></a>
+
+```typescript
+public readonly secretArn: string;
+```
+
+- *Type:* string
+
+---
+
 
 ### DomainEventMessagingExtension <a name="DomainEventMessagingExtension" id="@btc-embedded/cdk-extensions.DomainEventMessagingExtension"></a>