-
Notifications
You must be signed in to change notification settings - Fork 4
/
cloudformation.ts
413 lines (363 loc) · 9.78 KB
/
cloudformation.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
import { ClientRequestToken, Tag } from "./common"
/**
* CloudFormation stack id.
*/
export type StackId = string
/**
* CloudFormation stack name.
*/
export type StackName = string
/**
* CloudFormation stack status.
*/
export type StackStatus =
| "CREATE_IN_PROGRESS"
| "CREATE_FAILED"
| "CREATE_COMPLETE"
| "ROLLBACK_IN_PROGRESS"
| "ROLLBACK_FAILED"
| "ROLLBACK_COMPLETE"
| "DELETE_IN_PROGRESS"
| "DELETE_FAILED"
| "DELETE_COMPLETE"
| "DELETE_SKIPPED"
| "UPDATE_IN_PROGRESS"
| "UPDATE_FAILED"
| "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
| "UPDATE_COMPLETE"
| "UPDATE_ROLLBACK_IN_PROGRESS"
| "UPDATE_ROLLBACK_FAILED"
| "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
| "UPDATE_ROLLBACK_COMPLETE"
| "REVIEW_IN_PROGRESS"
| "IMPORT_IN_PROGRESS"
| "IMPORT_COMPLETE"
| "IMPORT_ROLLBACK_IN_PROGRESS"
| "IMPORT_ROLLBACK_FAILED"
| "IMPORT_ROLLBACK_COMPLETE"
/**
* @hidden
*/
export const ACTIVE_STACK_STATUSES: ReadonlyArray<StackStatus> = [
"CREATE_IN_PROGRESS",
"CREATE_FAILED",
"CREATE_COMPLETE",
"ROLLBACK_IN_PROGRESS",
"ROLLBACK_FAILED",
"ROLLBACK_COMPLETE",
"DELETE_IN_PROGRESS",
"DELETE_FAILED",
"UPDATE_IN_PROGRESS",
"UPDATE_COMPLETE_CLEANUP_IN_PROGRESS",
"UPDATE_COMPLETE",
"UPDATE_ROLLBACK_IN_PROGRESS",
"UPDATE_ROLLBACK_FAILED",
"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
"UPDATE_ROLLBACK_COMPLETE",
"REVIEW_IN_PROGRESS",
"IMPORT_IN_PROGRESS",
"IMPORT_COMPLETE",
"IMPORT_ROLLBACK_IN_PROGRESS",
"IMPORT_ROLLBACK_FAILED",
"IMPORT_ROLLBACK_COMPLETE",
]
/**
* CloudFormation stack status reason.
*/
export type StackStatusReason = string
/**
* CloudFormation stack termination protection.
*/
export type EnableTerminationProtection = boolean
/**
* CloudFormation stack capability.
*/
export type StackCapability =
| "CAPABILITY_IAM"
| "CAPABILITY_NAMED_IAM"
| "CAPABILITY_AUTO_EXPAND"
/**
* CloudFormation stack parameter key.
*/
export type StackParameterKey = string
/**
* CloudFormation stack parameter value.
*/
export type StackParameterValue = string
/**
* CloudFormation stack parameter value.
*/
export type StackParameterNoEcho = boolean
/**
* CloudFormation stack parameter description.
*/
export type StackParameterDescription = string
/**
* CloudFormation stack parameter.
*/
export interface StackParameter {
readonly key: StackParameterKey
readonly value: StackParameterValue
}
/**
* CloudFormation parameter declaration.
*/
export interface ParameterDeclaration {
readonly key: StackParameterKey
readonly description: StackParameterDescription
readonly noEcho: StackParameterNoEcho
readonly defaultValue?: StackParameterValue
}
/**
* Detailed CloudFormation stack parameter.
*/
export type DetailedStackParameter = StackParameter & ParameterDeclaration
/**
* CloudFormation stack output value.
*/
export type StackOutputValue = string
/**
* CloudFormation stack output key.
*/
export type StackOutputKey = string
/**
* CloudFormation stack output description.
*/
export type StackOutputDescription = string
/**
* CloudFormation stack output.
*/
export interface StackOutput {
readonly value: StackOutputValue
readonly key: StackOutputKey
readonly description: StackOutputDescription
}
/**
* CloudFormation stack creation time.
*/
export type CreationTime = Date
/**
* CloudFormation stack last updated time.
*/
export type LastUpdatedTime = Date
/**
* CloudFormation stack deletion time.
*/
export type DeletionTime = Date
/**
* CloudFormation stack summary.
*/
export interface CloudFormationStackSummary {
readonly id: StackId
readonly name: StackName
readonly status: StackStatus
readonly statusReason: StackStatusReason
readonly creationTime: CreationTime
readonly lastUpdatedTime?: LastUpdatedTime
readonly deletionTime?: DeletionTime
readonly driftInformation: StackDriftInformation
}
/**
* Detailed CloudFormation stack summary.
*/
export interface DetailedCloudFormationStackSummary
extends CloudFormationStackSummary {
readonly templateDescription: TemplateDescription
}
interface BaseCloudFormationStack<P> extends CloudFormationStackSummary {
readonly parameters: ReadonlyArray<P>
readonly capabilities: ReadonlyArray<StackCapability>
readonly enableTerminationProtection: EnableTerminationProtection
readonly outputs: ReadonlyArray<StackOutput>
readonly tags: ReadonlyArray<Tag>
}
/**
* CloudFormation stack.
*/
export type CloudFormationStack = BaseCloudFormationStack<StackParameter>
/**
* CloudFormation stack template.
*/
export type TemplateBody = string
/**
* CloudFormation stack template description.
*/
export type TemplateDescription = string
/**
* CloudFormation stack policy.
*/
export type StackPolicyBody = string
/**
* Detailed CloudFormation stack.
*/
export interface DetailedCloudFormationStack
extends BaseCloudFormationStack<DetailedStackParameter> {
readonly templateBody: TemplateBody
readonly stackPolicyBody?: StackPolicyBody
}
export interface TemplateSummary {
readonly parameters: ReadonlyArray<ParameterDeclaration>
}
export type LogicalResourceId = string
export type PhysicalResourceId = string
export type ResourceType = string
export type ResourceProperties = string
export type ResourceStatusReason = string
export type ResourceStatus =
| "CREATE_IN_PROGRESS"
| "CREATE_FAILED"
| "CREATE_COMPLETE"
| "DELETE_IN_PROGRESS"
| "DELETE_FAILED"
| "DELETE_COMPLETE"
| "DELETE_SKIPPED"
| "UPDATE_IN_PROGRESS"
| "UPDATE_FAILED"
| "UPDATE_COMPLETE"
| "IMPORT_FAILED"
| "IMPORT_COMPLETE"
| "IMPORT_IN_PROGRESS"
| "IMPORT_ROLLBACK_IN_PROGRESS"
| "IMPORT_ROLLBACK_FAILED"
| "IMPORT_ROLLBACK_COMPLETE"
| "ROLLBACK_COMPLETE"
| "ROLLBACK_FAILED"
| "UPDATE_ROLLBACK_COMPLETE"
| "UPDATE_ROLLBACK_FAILED"
export type EventId = string
export interface StackEvent {
id: EventId
stackId: StackId
stackName: StackName
logicalResourceId: LogicalResourceId
physicalResourceId?: PhysicalResourceId
resourceType: ResourceType
timestamp: Date
resourceStatus: ResourceStatus
resourceStatusReason?: ResourceStatusReason
resourceProperties?: ResourceProperties
clientRequestToken: ClientRequestToken
}
export type ChangeSetId = string
export type ChangeSetName = string
export type ChangeSetStatusReason = string
export type ChangeSetType = "CREATE" | "UPDATE"
export type ChangeSetStatus =
| "CREATE_PENDING"
| "CREATE_IN_PROGRESS"
| "CREATE_COMPLETE"
| "DELETE_COMPLETE"
| "FAILED"
export type ResourceAttribute =
| "Properties"
| "Metadata"
| "CreationPolicy"
| "UpdatePolicy"
| "DeletionPolicy"
| "Tags"
export type ChangeSource =
| "ResourceReference"
| "ParameterReference"
| "ResourceAttribute"
| "DirectModification"
| "Automatic"
export type CausingEntity = string
export type RequiresRecreation = "Never" | "Conditionally" | "Always"
export type PropertyName = string
export type EvaluationType = "Static" | "Dynamic"
export interface ResourceTargetDefinition {
readonly attribute: ResourceAttribute
readonly name: PropertyName
readonly requiresRecreation: RequiresRecreation
}
export interface ResourceChangeDetail {
readonly target?: ResourceTargetDefinition
readonly evaluation: EvaluationType
readonly changeSource: ChangeSource
readonly causingEntity?: CausingEntity
}
export type ChangeType = "Resource"
export type ResourceChangeAction = "Add" | "Modify" | "Remove" | "Import"
export type ResourceChangeReplacement = "True" | "False" | "Conditional"
export interface ResourceChange {
readonly action: ResourceChangeAction
readonly logicalResourceId: LogicalResourceId
readonly physicalResourceId?: PhysicalResourceId
readonly resourceType: ResourceType
readonly replacement: ResourceChangeReplacement
readonly scope: ReadonlyArray<ResourceAttribute>
readonly details: ReadonlyArray<ResourceChangeDetail>
}
export interface Change {
readonly type: ChangeType
readonly resourceChange: ResourceChange
}
export interface BaseChangeSet<P> {
readonly id: ChangeSetId
readonly name: ChangeSetName
readonly stackId: StackId
readonly status: ChangeSetStatus
readonly statusReason: ChangeSetStatusReason
readonly parameters: ReadonlyArray<P>
readonly changes: ReadonlyArray<Change>
readonly tags: ReadonlyArray<Tag>
}
export type ChangeSet = BaseChangeSet<StackParameter>
export type DetailedChangeSet = BaseChangeSet<DetailedStackParameter>
/**
* @hidden
*/
export const isTerminalResourceStatus = (status: ResourceStatus): boolean => {
switch (status) {
case "CREATE_COMPLETE":
case "DELETE_COMPLETE":
case "ROLLBACK_COMPLETE":
case "UPDATE_COMPLETE":
case "ROLLBACK_FAILED":
case "CREATE_FAILED":
case "DELETE_FAILED":
case "IMPORT_FAILED":
case "IMPORT_COMPLETE":
case "IMPORT_ROLLBACK_COMPLETE":
case "IMPORT_ROLLBACK_FAILED":
case "UPDATE_ROLLBACK_COMPLETE":
case "UPDATE_ROLLBACK_FAILED":
return true
default:
return false
}
}
/**
* @hidden
*/
export const ALLOW_ALL_STACK_POLICY = `{
"Statement": [
{
"Effect": "Allow",
"Action": "Update:*",
"Principal": "*",
"Resource": "*"
}
]
}
`
export type StackDriftDetectionId = string
export type StackDriftDetectionStatusReason = string
export type StackDriftStatus = "DRIFTED" | "IN_SYNC" | "UNKNOWN" | "NOT_CHECKED"
export type StackDriftDetectionStatus =
| "DETECTION_IN_PROGRESS"
| "DETECTION_FAILED"
| "DETECTION_COMPLETE"
export interface StackDriftDetectionStatusOutput {
readonly stackId: StackId
readonly stackDriftDetectionId: StackDriftDetectionId
readonly stackDriftStatus: StackDriftStatus
readonly detectionStatus: StackDriftDetectionStatus
readonly detectionStatusReason: StackDriftDetectionStatusReason
readonly driftedStackResourceCount: number
readonly timestamp: Date
}
export interface StackDriftInformation {
stackDriftStatus: StackDriftStatus
lastCheckTimestamp?: Date
}