awscfn 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -1
- package/bin/awscfn +9 -0
- package/dist/lib/cfn/index.d.ts +1 -0
- package/dist/lib/cfn/index.d.ts.map +1 -1
- package/dist/lib/cfn/index.js +1 -0
- package/dist/lib/cfn/index.js.map +1 -1
- package/dist/lib/cfn/listStacks.d.ts +6 -0
- package/dist/lib/cfn/listStacks.d.ts.map +1 -0
- package/dist/lib/cfn/listStacks.js +21 -0
- package/dist/lib/cfn/listStacks.js.map +1 -0
- package/dist/listStacks.d.ts +5 -0
- package/dist/listStacks.d.ts.map +1 -0
- package/dist/listStacks.js +70 -0
- package/dist/listStacks.js.map +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ CLI and TypeScript SDK for managing AWS CloudFormation stacks.
|
|
|
14
14
|
## Why awscfn?
|
|
15
15
|
|
|
16
16
|
- **Simple YAML parameters** — No more wrestling with verbose JSON. Just clean, readable YAML files.
|
|
17
|
-
- **See what's happening** — Real-time event streaming
|
|
17
|
+
- **See what's happening** — Real-time event streaming in your terminal. No refreshing the console, no juggling `aws cloudformation create-stack` and `describe-stack-events` in another window.
|
|
18
18
|
- **Errors that make sense** — When deploys fail, you get the actual error message from CloudFormation, not a cryptic timeout.
|
|
19
19
|
- **CI/CD friendly** — Works great in GitHub Actions with auto-detected CI mode.
|
|
20
20
|
- **CLI & SDK** — Use from command line or import directly in Node.js/TypeScript projects.
|
|
@@ -57,6 +57,16 @@ During stack operations, awscfn streams CloudFormation stack events in real-time
|
|
|
57
57
|
|
|
58
58
|
When a failure occurs, the error message includes the actual reason from CloudFormation events.
|
|
59
59
|
|
|
60
|
+
### 📋 list-stacks
|
|
61
|
+
|
|
62
|
+
List all CloudFormation stacks in the current region (name, status, creation date).
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npx awscfn list-stacks
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
No options. Output is a table of stack name, status, and creation date.
|
|
69
|
+
|
|
60
70
|
### 🚀 create-stack
|
|
61
71
|
|
|
62
72
|
```bash
|
|
@@ -129,6 +139,19 @@ If the names don't match, the deletion will be aborted.
|
|
|
129
139
|
|
|
130
140
|
> ⚠️ Requires AWS credentials to be configured in your shell or environment. [Start here](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) if you haven't already.
|
|
131
141
|
|
|
142
|
+
### 📋 `listStacks(): Promise<StackSummary[]>`
|
|
143
|
+
|
|
144
|
+
Returns all CloudFormation stacks in the current region (paginated). Excludes `DELETE_COMPLETE` (AWS default). Each item is an AWS SDK `StackSummary` (e.g. `StackName`, `StackStatus`, `CreationTime`).
|
|
145
|
+
|
|
146
|
+
```ts
|
|
147
|
+
import { listStacks } from 'awscfn';
|
|
148
|
+
|
|
149
|
+
const stacks = await listStacks();
|
|
150
|
+
for (const s of stacks) {
|
|
151
|
+
console.log(s.StackName, s.StackStatus);
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
132
155
|
### 📦 `createStack(stackName: string, template: Template<P>): Promise<Stack>`
|
|
133
156
|
|
|
134
157
|
Creates a new CloudFormation stack using a change set and waits for it to complete or fail.
|
package/bin/awscfn
CHANGED
|
@@ -6,6 +6,7 @@ const yargs = require('yargs');
|
|
|
6
6
|
|
|
7
7
|
const { createStack } = require('../dist/createStack');
|
|
8
8
|
const { deleteStack } = require('../dist/deleteStack');
|
|
9
|
+
const { listStacks } = require('../dist/listStacks');
|
|
9
10
|
const { redeployStack } = require('../dist/redeployStack');
|
|
10
11
|
const { updateStack } = require('../dist/updateStack');
|
|
11
12
|
const { setOutputConfig } = require('../dist/lib/output');
|
|
@@ -109,6 +110,14 @@ yargs
|
|
|
109
110
|
color: !argv.noColor && (process.stdout.isTTY || argv.ci),
|
|
110
111
|
});
|
|
111
112
|
})
|
|
113
|
+
.command(
|
|
114
|
+
'list-stacks',
|
|
115
|
+
'List all CloudFormation stacks',
|
|
116
|
+
(cmd) => cmd,
|
|
117
|
+
() => {
|
|
118
|
+
runCommand(() => listStacks());
|
|
119
|
+
}
|
|
120
|
+
)
|
|
112
121
|
.command(
|
|
113
122
|
'create-stack',
|
|
114
123
|
'Create a CloudFormation stack',
|
package/dist/lib/cfn/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ export declare function initCloudFormationClient(): void;
|
|
|
8
8
|
export declare function getCfClient(): CloudFormationClient;
|
|
9
9
|
export * from './createStack';
|
|
10
10
|
export * from './getStackByName';
|
|
11
|
+
export * from './listStacks';
|
|
11
12
|
export * from './updateStack';
|
|
12
13
|
export * from './deleteStack';
|
|
13
14
|
export * from './validateTemplate';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/cfn/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,gCAAgC,CAAC;AAEpE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACjD,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,cAAc,IAAI;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,CAAA;CACZ,GAAG,MAAM,CAAC;AAIX,wBAAgB,wBAAwB,IAAI,IAAI,CAI/C;AAED,wBAAgB,WAAW,IAAI,oBAAoB,CAMlD;AAED,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/cfn/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,gCAAgC,CAAC;AAEpE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACjD,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,cAAc,IAAI;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,CAAA;CACZ,GAAG,MAAM,CAAC;AAIX,wBAAgB,wBAAwB,IAAI,IAAI,CAI/C;AAED,wBAAgB,WAAW,IAAI,oBAAoB,CAMlD;AAED,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC"}
|
package/dist/lib/cfn/index.js
CHANGED
|
@@ -28,6 +28,7 @@ function getCfClient() {
|
|
|
28
28
|
}
|
|
29
29
|
__exportStar(require("./createStack"), exports);
|
|
30
30
|
__exportStar(require("./getStackByName"), exports);
|
|
31
|
+
__exportStar(require("./listStacks"), exports);
|
|
31
32
|
__exportStar(require("./updateStack"), exports);
|
|
32
33
|
__exportStar(require("./deleteStack"), exports);
|
|
33
34
|
__exportStar(require("./validateTemplate"), exports);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/cfn/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAUA,4DAIC;AAED,kCAMC;AAtBD,0EAAoE;AAQpE,IAAI,EAAkC,CAAC;AAEvC,SAAgB,wBAAwB;IAEpC,EAAE,GAAG,IAAI,4CAAoB,EAAE,CAAC;AAEpC,CAAC;AAED,SAAgB,WAAW;IAEvB,IAAI,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAElE,OAAO,EAAE,CAAC;AAEd,CAAC;AAED,gDAA8B;AAC9B,mDAAiC;AACjC,gDAA8B;AAC9B,gDAA8B;AAC9B,qDAAmC;AACnC,sDAAoC;AACpC,oDAAkC;AAClC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/cfn/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAUA,4DAIC;AAED,kCAMC;AAtBD,0EAAoE;AAQpE,IAAI,EAAkC,CAAC;AAEvC,SAAgB,wBAAwB;IAEpC,EAAE,GAAG,IAAI,4CAAoB,EAAE,CAAC;AAEpC,CAAC;AAED,SAAgB,WAAW;IAEvB,IAAI,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAElE,OAAO,EAAE,CAAC;AAEd,CAAC;AAED,gDAA8B;AAC9B,mDAAiC;AACjC,+CAA6B;AAC7B,gDAA8B;AAC9B,gDAA8B;AAC9B,qDAAmC;AACnC,sDAAoC;AACpC,oDAAkC;AAClC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { StackSummary } from '@aws-sdk/client-cloudformation';
|
|
2
|
+
/**
|
|
3
|
+
* Fetches all CloudFormation stacks (paginated). Excludes DELETE_COMPLETE by default (AWS behavior).
|
|
4
|
+
*/
|
|
5
|
+
export declare function listStacks(): Promise<StackSummary[]>;
|
|
6
|
+
//# sourceMappingURL=listStacks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listStacks.d.ts","sourceRoot":"","sources":["../../../src/lib/cfn/listStacks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAC,MAAM,gCAAgC,CAAC;AAG/E;;GAEG;AACH,wBAAsB,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAkB1D"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.listStacks = listStacks;
|
|
4
|
+
const client_cloudformation_1 = require("@aws-sdk/client-cloudformation");
|
|
5
|
+
const _1 = require(".");
|
|
6
|
+
/**
|
|
7
|
+
* Fetches all CloudFormation stacks (paginated). Excludes DELETE_COMPLETE by default (AWS behavior).
|
|
8
|
+
*/
|
|
9
|
+
async function listStacks() {
|
|
10
|
+
const cf = (0, _1.getCfClient)();
|
|
11
|
+
const out = [];
|
|
12
|
+
let nextToken;
|
|
13
|
+
do {
|
|
14
|
+
const result = await cf.send(new client_cloudformation_1.ListStacksCommand({ NextToken: nextToken }));
|
|
15
|
+
const summaries = result.StackSummaries ?? [];
|
|
16
|
+
out.push(...summaries);
|
|
17
|
+
nextToken = result.NextToken;
|
|
18
|
+
} while (nextToken);
|
|
19
|
+
return out;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=listStacks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listStacks.js","sourceRoot":"","sources":["../../../src/lib/cfn/listStacks.ts"],"names":[],"mappings":";;AAMA,gCAkBC;AAxBD,0EAA+E;AAC/E,wBAA8B;AAE9B;;GAEG;AACI,KAAK,UAAU,UAAU;IAE5B,MAAM,EAAE,GAAG,IAAA,cAAW,GAAE,CAAC;IACzB,MAAM,GAAG,GAAmB,EAAE,CAAC;IAC/B,IAAI,SAA6B,CAAC;IAElC,GAAG,CAAC;QAEA,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,yCAAiB,CAAC,EAAC,SAAS,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;QAC5E,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC;QAE9C,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;QACvB,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;IAEjC,CAAC,QAAQ,SAAS,EAAE;IAEpB,OAAO,GAAG,CAAC;AAEf,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listStacks.d.ts","sourceRoot":"","sources":["../src/listStacks.ts"],"names":[],"mappings":"AASA;;GAEG;AACH,wBAAsB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAkChD"}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
+
exports.listStacks = listStacks;
|
|
37
|
+
const cfn = __importStar(require("./lib/cfn"));
|
|
38
|
+
const output_1 = require("./lib/output");
|
|
39
|
+
const colors = {
|
|
40
|
+
dim: '\x1b[2m',
|
|
41
|
+
gray: '\x1b[90m',
|
|
42
|
+
reset: '\x1b[0m',
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* CLI handler: list all CloudFormation stacks.
|
|
46
|
+
*/
|
|
47
|
+
async function listStacks() {
|
|
48
|
+
cfn.initCloudFormationClient();
|
|
49
|
+
const stacks = await cfn.listStacks();
|
|
50
|
+
const config = (0, output_1.getOutputConfig)();
|
|
51
|
+
if (stacks.length === 0) {
|
|
52
|
+
console.log('No stacks found.');
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
const maxName = Math.max(20, ...stacks.map((s) => (s.StackName ?? '').length));
|
|
56
|
+
const headerName = 'STACK NAME'.padEnd(maxName);
|
|
57
|
+
const headerStatus = 'STATUS';
|
|
58
|
+
const headerCreated = 'CREATED';
|
|
59
|
+
console.log(config.color ? (0, output_1.colorize)(`${headerName} ${headerStatus} ${headerCreated}`, colors.dim) : `${headerName} ${headerStatus} ${headerCreated}`);
|
|
60
|
+
console.log(config.color ? (0, output_1.colorize)('-'.repeat(headerName.length + 2 + headerStatus.length + 2 + 10), colors.gray) : '-'.repeat(headerName.length + 2 + headerStatus.length + 2 + 10));
|
|
61
|
+
for (const s of stacks) {
|
|
62
|
+
const name = (s.StackName ?? '—').padEnd(maxName);
|
|
63
|
+
const status = s.StackStatus ?? '—';
|
|
64
|
+
const created = s.CreationTime
|
|
65
|
+
? s.CreationTime.toISOString().slice(0, 10)
|
|
66
|
+
: '—';
|
|
67
|
+
console.log(`${name} ${status} ${created}`);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
//# sourceMappingURL=listStacks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"listStacks.js","sourceRoot":"","sources":["../src/listStacks.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,gCAkCC;AA9CD,+CAAiC;AACjC,yCAAuD;AAEvD,MAAM,MAAM,GAAG;IACX,GAAG,EAAE,SAAS;IACd,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,SAAS;CACnB,CAAC;AAEF;;GAEG;AACI,KAAK,UAAU,UAAU;IAE5B,GAAG,CAAC,wBAAwB,EAAE,CAAC;IAE/B,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,IAAA,wBAAe,GAAE,CAAC;IAEjC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAEtB,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAChC,OAAO;IAEX,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/E,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,QAAQ,CAAC;IAC9B,MAAM,aAAa,GAAG,SAAS,CAAC;IAEhC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,iBAAQ,EAAC,GAAG,UAAU,KAAK,YAAY,KAAK,aAAa,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,KAAK,YAAY,KAAK,aAAa,EAAE,CAAC,CAAC;IAC1J,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,iBAAQ,EAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAEvL,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QAErB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,CAAC,CAAC,WAAW,IAAI,GAAG,CAAC;QACpC,MAAM,OAAO,GAAG,CAAC,CAAC,YAAY;YAC1B,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;YAC3C,CAAC,CAAC,GAAG,CAAC;QAEV,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,KAAK,MAAM,KAAK,OAAO,EAAE,CAAC,CAAC;IAElD,CAAC;AAEL,CAAC"}
|
package/package.json
CHANGED