cloudformation-stack-drift-detector 0.1.1

package/API.md

@@ -0,0 +1,291 @@
+# API Reference <a name="API Reference" id="api-reference"></a>
+
+## Constructs <a name="Constructs" id="Constructs"></a>
+
+### CloudformationStackDriftDetector <a name="CloudformationStackDriftDetector" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector"></a>
+
+CDK construct that runs CloudFormation stack drift detection daily and publishes drifted stacks to SNS.
+
+Target stacks are selected by {@link TargetResource} when provided. When omitted,
+every stable stack in the account and region is inspected.
+
+#### Initializers <a name="Initializers" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.Initializer"></a>
+
+```typescript
+import { CloudformationStackDriftDetector } from 'cloudformation-stack-drift-detector'
+
+new CloudformationStackDriftDetector(scope: Construct, id: string, props: CloudformationStackDriftDetectorProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | - Parent construct. |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.Initializer.parameter.id">id</a></code> | <code>string</code> | - Construct id. |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.Initializer.parameter.props">props</a></code> | <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps">CloudformationStackDriftDetectorProps</a></code> | - Notification topic, optional tag filter, and durable execution settings. |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+Parent construct.
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+Construct id.
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps">CloudformationStackDriftDetectorProps</a>
+
+Notification topic, optional tag filter, and durable execution settings.
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.with">with</a></code> | Applies one or more mixins to this construct. |
+
+---
+
+##### `toString` <a name="toString" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+##### `with` <a name="with" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.with"></a>
+
+```typescript
+public with(mixins: ...IMixin[]): IConstruct
+```
+
+Applies one or more mixins to this construct.
+
+Mixins are applied in order. The list of constructs is captured at the
+start of the call, so constructs added by a mixin will not be visited.
+Use multiple `with()` calls if subsequent mixins should apply to added
+constructs.
+
+###### `mixins`<sup>Required</sup> <a name="mixins" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.with.parameter.mixins"></a>
+
+- *Type:* ...constructs.IMixin[]
+
+The mixins to apply.
+
+---
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.isConstruct"></a>
+
+```typescript
+import { CloudformationStackDriftDetector } from 'cloudformation-stack-drift-detector'
+
+CloudformationStackDriftDetector.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetector.property.notificationTopic">notificationTopic</a></code> | <code>aws-cdk-lib.aws_sns.ITopic</code> | SNS topic that receives drift notifications. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `notificationTopic`<sup>Required</sup> <a name="notificationTopic" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetector.property.notificationTopic"></a>
+
+```typescript
+public readonly notificationTopic: ITopic;
+```
+
+- *Type:* aws-cdk-lib.aws_sns.ITopic
+
+SNS topic that receives drift notifications.
+
+---
+
+
+## Structs <a name="Structs" id="Structs"></a>
+
+### CloudformationStackDriftDetectorProps <a name="CloudformationStackDriftDetectorProps" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps"></a>
+
+Properties for {@link CloudformationStackDriftDetector}.
+
+#### Initializer <a name="Initializer" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.Initializer"></a>
+
+```typescript
+import { CloudformationStackDriftDetectorProps } from 'cloudformation-stack-drift-detector'
+
+const cloudformationStackDriftDetectorProps: CloudformationStackDriftDetectorProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.notificationTopic">notificationTopic</a></code> | <code>aws-cdk-lib.aws_sns.ITopic</code> | SNS topic used to notify when a stack has drifted. |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.executionTimeout">executionTimeout</a></code> | <code>aws-cdk-lib.Duration</code> | Maximum duration of a durable execution. |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.retentionPeriod">retentionPeriod</a></code> | <code>aws-cdk-lib.Duration</code> | How long durable execution history is retained after completion. |
+| <code><a href="#cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.targetResource">targetResource</a></code> | <code><a href="#cloudformation-stack-drift-detector.TargetResource">TargetResource</a></code> | Tag filter used to select target stacks. |
+
+---
+
+##### `notificationTopic`<sup>Required</sup> <a name="notificationTopic" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.notificationTopic"></a>
+
+```typescript
+public readonly notificationTopic: ITopic;
+```
+
+- *Type:* aws-cdk-lib.aws_sns.ITopic
+
+SNS topic used to notify when a stack has drifted.
+
+---
+
+##### `executionTimeout`<sup>Optional</sup> <a name="executionTimeout" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.executionTimeout"></a>
+
+```typescript
+public readonly executionTimeout: Duration;
+```
+
+- *Type:* aws-cdk-lib.Duration
+- *Default:* Duration.hours(1)
+
+Maximum duration of a durable execution.
+
+---
+
+##### `retentionPeriod`<sup>Optional</sup> <a name="retentionPeriod" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.retentionPeriod"></a>
+
+```typescript
+public readonly retentionPeriod: Duration;
+```
+
+- *Type:* aws-cdk-lib.Duration
+- *Default:* Duration.days(30)
+
+How long durable execution history is retained after completion.
+
+---
+
+##### `targetResource`<sup>Optional</sup> <a name="targetResource" id="cloudformation-stack-drift-detector.CloudformationStackDriftDetectorProps.property.targetResource"></a>
+
+```typescript
+public readonly targetResource: TargetResource;
+```
+
+- *Type:* <a href="#cloudformation-stack-drift-detector.TargetResource">TargetResource</a>
+
+Tag filter used to select target stacks.
+
+If omitted, all stacks in the account and region are inspected.
+
+---
+
+### TargetResource <a name="TargetResource" id="cloudformation-stack-drift-detector.TargetResource"></a>
+
+Tag filter used to select CloudFormation stacks for drift detection.
+
+When `tagValues` is omitted, all stacks that have `tagKey` are selected.
+
+#### Initializer <a name="Initializer" id="cloudformation-stack-drift-detector.TargetResource.Initializer"></a>
+
+```typescript
+import { TargetResource } from 'cloudformation-stack-drift-detector'
+
+const targetResource: TargetResource = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cloudformation-stack-drift-detector.TargetResource.property.tagKey">tagKey</a></code> | <code>string</code> | Tag key used for stack discovery. |
+| <code><a href="#cloudformation-stack-drift-detector.TargetResource.property.tagValues">tagValues</a></code> | <code>string[]</code> | Tag values to match. |
+
+---
+
+##### `tagKey`<sup>Required</sup> <a name="tagKey" id="cloudformation-stack-drift-detector.TargetResource.property.tagKey"></a>
+
+```typescript
+public readonly tagKey: string;
+```
+
+- *Type:* string
+
+Tag key used for stack discovery.
+
+---
+
+##### `tagValues`<sup>Optional</sup> <a name="tagValues" id="cloudformation-stack-drift-detector.TargetResource.property.tagValues"></a>
+
+```typescript
+public readonly tagValues: string[];
+```
+
+- *Type:* string[]
+
+Tag values to match.
+
+If omitted, any value for {@link TargetResource.tagKey} is accepted.
+
+---
+
+
+

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,134 @@
+# CloudFormation Stack Drift Detector (AWS CDK V2)
+
+[![npm version](https://img.shields.io/npm/v/cloudformation-stack-drift-detector.svg)](https://www.npmjs.com/package/cloudformation-stack-drift-detector)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](https://nodejs.org/)
+
+AWS CDK construct that runs CloudFormation stack drift detection on a daily schedule and publishes drifted stacks to Amazon SNS.
+
+## Features
+
+- Daily EventBridge schedule (`rate(1 day)`) that invokes a durable Lambda alias
+- Optional tag-based stack selection; omit the filter to inspect all stable stacks in the account and region
+- Match a tag key with specific values, or any value when `tagValues` is omitted
+- Sequential DetectStackDrift per stack, with status polling until detection completes
+- SNS notifications when a stack is `DRIFTED`, including modified and deleted resource drifts
+- Caller-provided SNS topic for notifications (the construct does not create a topic)
+- Configurable durable execution timeout and history retention
+
+## Installation
+
+```bash
+npm install cloudformation-stack-drift-detector
+```
+
+```bash
+yarn add cloudformation-stack-drift-detector
+```
+
+`aws-cdk-lib` and `constructs` are peer dependencies and must be installed in your project.
+
+## Usage
+
+Inspect every stable CloudFormation stack in the account and region. Provide an SNS topic for drift notifications:
+
+```typescript
+import { Stack } from 'aws-cdk-lib';
+import * as sns from 'aws-cdk-lib/aws-sns';
+import { Construct } from 'constructs';
+import { CloudformationStackDriftDetector } from 'cloudformation-stack-drift-detector';
+
+export class DetectorStack extends Stack {
+  constructor(scope: Construct, id: string) {
+    super(scope, id);
+
+    const topic = new sns.Topic(this, 'DriftNotifications');
+
+    new CloudformationStackDriftDetector(this, 'Detector', {
+      notificationTopic: topic,
+    });
+  }
+}
+```
+
+### Select stacks by tag
+
+Pass `targetResource` to discover stacks through the Resource Groups Tagging API:
+
+```typescript
+new CloudformationStackDriftDetector(this, 'Detector', {
+  notificationTopic: topic,
+  targetResource: {
+    tagKey: 'DriftDetection',
+    tagValues: ['enabled'],
+  },
+});
+```
+
+Omit `tagValues` to select every stack that has the tag key, regardless of value:
+
+```typescript
+new CloudformationStackDriftDetector(this, 'Detector', {
+  notificationTopic: topic,
+  targetResource: {
+    tagKey: 'DriftDetection',
+  },
+});
+```
+
+### Use an existing SNS topic
+
+```typescript
+import * as sns from 'aws-cdk-lib/aws-sns';
+
+const topic = sns.Topic.fromTopicArn(
+  this,
+  'ExistingTopic',
+  'arn:aws:sns:us-east-1:123456789012:drift-notifications',
+);
+
+new CloudformationStackDriftDetector(this, 'Detector', {
+  notificationTopic: topic,
+});
+```
+
+### Durable execution settings
+
+```typescript
+import { Duration } from 'aws-cdk-lib';
+
+new CloudformationStackDriftDetector(this, 'Detector', {
+  notificationTopic: topic,
+  executionTimeout: Duration.hours(2),
+  retentionPeriod: Duration.days(14),
+});
+```
+
+## Options
+
+These options apply to `CloudformationStackDriftDetector`.
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `notificationTopic` | `sns.ITopic` | Yes | SNS topic that receives drift notifications. The construct does not create a topic. |
+| `targetResource` | `TargetResource` | No | Tag filter used to select stacks. If omitted, all stable stacks in the account and region are inspected. |
+| `executionTimeout` | `Duration` | No | Maximum duration of a durable execution (default: `Duration.hours(1)`). |
+| `retentionPeriod` | `Duration` | No | How long durable execution history is retained after completion (default: `Duration.days(30)`). |
+
+### TargetResource
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `tagKey` | `string` | Yes | Tag key used for stack discovery. |
+| `tagValues` | `string[]` | No | Tag values to match. If omitted, any value for `tagKey` is accepted. |
+
+## Requirements
+
+- Node.js `>= 20.0.0`
+- `aws-cdk-lib` `^2.232.0`
+- `constructs` `^10.5.1`
+- AWS – EventBridge; Lambda with Durable Execution (Node.js 22.x) and a `live` alias; CloudFormation (`DetectStackDrift`, `DescribeStackDriftDetectionStatus`, `DescribeStackResourceDrifts`, `ListStacks`); Resource Groups Tagging API (`tag:GetResources`); SNS
+
+## License
+
+This project is licensed under the Apache-2.0 License.