@gammarers/aws-stepfunctions-execution-status-change-notification-stack 1.1.23 → 2.0.1
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/.devcontainer/.gitconfig +4 -0
- package/.devcontainer/devcontainer.json +54 -0
- package/.jsii +381 -92
- package/API.md +175 -163
- package/README.md +2 -2
- package/lib/index.d.ts +3 -3
- package/lib/index.js +5 -5
- package/package.json +6 -6
package/API.md
CHANGED
|
@@ -2,39 +2,39 @@
|
|
|
2
2
|
|
|
3
3
|
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
4
|
|
|
5
|
-
###
|
|
5
|
+
### StepFunctionsExecutionStatusChangeNotificationStack <a name="StepFunctionsExecutionStatusChangeNotificationStack" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack"></a>
|
|
6
6
|
|
|
7
|
-
#### Initializers <a name="Initializers" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
7
|
+
#### Initializers <a name="Initializers" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.Initializer"></a>
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
import {
|
|
10
|
+
import { StepFunctionsExecutionStatusChangeNotificationStack } from '@gammarers/aws-stepfunctions-execution-status-change-notification-stack'
|
|
11
11
|
|
|
12
|
-
new
|
|
12
|
+
new StepFunctionsExecutionStatusChangeNotificationStack(scope: Construct, id: string, props: StepFunctionsExecutionStatusChangeNotificationStackProps)
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
| **Name** | **Type** | **Description** |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
18
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
19
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
17
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
18
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
19
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.Initializer.parameter.props">props</a></code> | <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps">StepFunctionsExecutionStatusChangeNotificationStackProps</a></code> | *No description.* |
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
23
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.Initializer.parameter.scope"></a>
|
|
24
24
|
|
|
25
25
|
- *Type:* constructs.Construct
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
29
|
-
##### `id`<sup>Required</sup> <a name="id" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
29
|
+
##### `id`<sup>Required</sup> <a name="id" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.Initializer.parameter.id"></a>
|
|
30
30
|
|
|
31
31
|
- *Type:* string
|
|
32
32
|
|
|
33
33
|
---
|
|
34
34
|
|
|
35
|
-
##### `props`<sup>Required</sup> <a name="props" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
35
|
+
##### `props`<sup>Required</sup> <a name="props" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.Initializer.parameter.props"></a>
|
|
36
36
|
|
|
37
|
-
- *Type:* <a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
37
|
+
- *Type:* <a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps">StepFunctionsExecutionStatusChangeNotificationStackProps</a>
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -42,25 +42,25 @@ new StepFunctionsExecutionStatueChangeNotificationStack(scope: Construct, id: st
|
|
|
42
42
|
|
|
43
43
|
| **Name** | **Description** |
|
|
44
44
|
| --- | --- |
|
|
45
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
46
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
47
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
48
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
49
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
50
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
51
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
52
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
53
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
54
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
55
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
56
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
57
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
58
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
59
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
##### `toString` <a name="toString" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
45
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
46
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addDependency">addDependency</a></code> | Add a dependency between this stack and another stack. |
|
|
47
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addMetadata">addMetadata</a></code> | Adds an arbitrary key-value pair, with information you want to record about the stack. |
|
|
48
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addTransform">addTransform</a></code> | Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. |
|
|
49
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportStringListValue">exportStringListValue</a></code> | Create a CloudFormation Export for a string list value. |
|
|
50
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportValue">exportValue</a></code> | Create a CloudFormation Export for a string value. |
|
|
51
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.formatArn">formatArn</a></code> | Creates an ARN from components. |
|
|
52
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.getLogicalId">getLogicalId</a></code> | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. |
|
|
53
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.regionalFact">regionalFact</a></code> | Look up a fact value for the given fact for the region of this stack. |
|
|
54
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.renameLogicalId">renameLogicalId</a></code> | Rename a generated logical identities. |
|
|
55
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.reportMissingContextKey">reportMissingContextKey</a></code> | Indicate that a context key was expected. |
|
|
56
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.resolve">resolve</a></code> | Resolve a tokenized value in the context of the current stack. |
|
|
57
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.splitArn">splitArn</a></code> | Splits the provided ARN into its components. |
|
|
58
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toJsonString">toJsonString</a></code> | Convert an object, potentially containing tokens, to a JSON string. |
|
|
59
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toYamlString">toYamlString</a></code> | Convert an object, potentially containing tokens, to a YAML string. |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
##### `toString` <a name="toString" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toString"></a>
|
|
64
64
|
|
|
65
65
|
```typescript
|
|
66
66
|
public toString(): string
|
|
@@ -68,7 +68,7 @@ public toString(): string
|
|
|
68
68
|
|
|
69
69
|
Returns a string representation of this construct.
|
|
70
70
|
|
|
71
|
-
##### `addDependency` <a name="addDependency" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
71
|
+
##### `addDependency` <a name="addDependency" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addDependency"></a>
|
|
72
72
|
|
|
73
73
|
```typescript
|
|
74
74
|
public addDependency(target: Stack, reason?: string): void
|
|
@@ -79,43 +79,43 @@ Add a dependency between this stack and another stack.
|
|
|
79
79
|
This can be used to define dependencies between any two stacks within an
|
|
80
80
|
app, and also supports nested stacks.
|
|
81
81
|
|
|
82
|
-
###### `target`<sup>Required</sup> <a name="target" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
82
|
+
###### `target`<sup>Required</sup> <a name="target" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addDependency.parameter.target"></a>
|
|
83
83
|
|
|
84
84
|
- *Type:* aws-cdk-lib.Stack
|
|
85
85
|
|
|
86
86
|
---
|
|
87
87
|
|
|
88
|
-
###### `reason`<sup>Optional</sup> <a name="reason" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
88
|
+
###### `reason`<sup>Optional</sup> <a name="reason" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addDependency.parameter.reason"></a>
|
|
89
89
|
|
|
90
90
|
- *Type:* string
|
|
91
91
|
|
|
92
92
|
---
|
|
93
93
|
|
|
94
|
-
##### `addMetadata` <a name="addMetadata" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
94
|
+
##### `addMetadata` <a name="addMetadata" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addMetadata"></a>
|
|
95
95
|
|
|
96
96
|
```typescript
|
|
97
97
|
public addMetadata(key: string, value: any): void
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
Adds an
|
|
100
|
+
Adds an arbitrary key-value pair, with information you want to record about the stack.
|
|
101
101
|
|
|
102
102
|
These get translated to the Metadata section of the generated template.
|
|
103
103
|
|
|
104
104
|
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html)
|
|
105
105
|
|
|
106
|
-
###### `key`<sup>Required</sup> <a name="key" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
106
|
+
###### `key`<sup>Required</sup> <a name="key" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addMetadata.parameter.key"></a>
|
|
107
107
|
|
|
108
108
|
- *Type:* string
|
|
109
109
|
|
|
110
110
|
---
|
|
111
111
|
|
|
112
|
-
###### `value`<sup>Required</sup> <a name="value" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
112
|
+
###### `value`<sup>Required</sup> <a name="value" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addMetadata.parameter.value"></a>
|
|
113
113
|
|
|
114
114
|
- *Type:* any
|
|
115
115
|
|
|
116
116
|
---
|
|
117
117
|
|
|
118
|
-
##### `addTransform` <a name="addTransform" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
118
|
+
##### `addTransform` <a name="addTransform" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addTransform"></a>
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
121
|
public addTransform(transform: string): void
|
|
@@ -136,7 +136,7 @@ stack.addTransform('AWS::Serverless-2016-10-31')
|
|
|
136
136
|
```
|
|
137
137
|
|
|
138
138
|
|
|
139
|
-
###### `transform`<sup>Required</sup> <a name="transform" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
139
|
+
###### `transform`<sup>Required</sup> <a name="transform" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.addTransform.parameter.transform"></a>
|
|
140
140
|
|
|
141
141
|
- *Type:* string
|
|
142
142
|
|
|
@@ -144,7 +144,7 @@ The transform to add.
|
|
|
144
144
|
|
|
145
145
|
---
|
|
146
146
|
|
|
147
|
-
##### `exportStringListValue` <a name="exportStringListValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
147
|
+
##### `exportStringListValue` <a name="exportStringListValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportStringListValue"></a>
|
|
148
148
|
|
|
149
149
|
```typescript
|
|
150
150
|
public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]
|
|
@@ -170,19 +170,19 @@ the resource and the manual export.
|
|
|
170
170
|
|
|
171
171
|
See `exportValue` for an example of this process.
|
|
172
172
|
|
|
173
|
-
###### `exportedValue`<sup>Required</sup> <a name="exportedValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
173
|
+
###### `exportedValue`<sup>Required</sup> <a name="exportedValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportStringListValue.parameter.exportedValue"></a>
|
|
174
174
|
|
|
175
175
|
- *Type:* any
|
|
176
176
|
|
|
177
177
|
---
|
|
178
178
|
|
|
179
|
-
###### `options`<sup>Optional</sup> <a name="options" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
179
|
+
###### `options`<sup>Optional</sup> <a name="options" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportStringListValue.parameter.options"></a>
|
|
180
180
|
|
|
181
181
|
- *Type:* aws-cdk-lib.ExportValueOptions
|
|
182
182
|
|
|
183
183
|
---
|
|
184
184
|
|
|
185
|
-
##### `exportValue` <a name="exportValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
185
|
+
##### `exportValue` <a name="exportValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportValue"></a>
|
|
186
186
|
|
|
187
187
|
```typescript
|
|
188
188
|
public exportValue(exportedValue: any, options?: ExportValueOptions): string
|
|
@@ -205,8 +205,6 @@ temporarily ensure that the CloudFormation Export still exists while you
|
|
|
205
205
|
remove the reference from the consuming stack. After that, you can remove
|
|
206
206
|
the resource and the manual export.
|
|
207
207
|
|
|
208
|
-
## Example
|
|
209
|
-
|
|
210
208
|
Here is how the process works. Let's say there are two stacks,
|
|
211
209
|
`producerStack` and `consumerStack`, and `producerStack` has a bucket
|
|
212
210
|
called `bucket`, which is referenced by `consumerStack` (perhaps because
|
|
@@ -217,7 +215,7 @@ deleted, `consumerStack` might still be using it.
|
|
|
217
215
|
|
|
218
216
|
Instead, the process takes two deployments:
|
|
219
217
|
|
|
220
|
-
|
|
218
|
+
**Deployment 1: break the relationship**:
|
|
221
219
|
|
|
222
220
|
- Make sure `consumerStack` no longer references `bucket.bucketName` (maybe the consumer
|
|
223
221
|
stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just
|
|
@@ -227,25 +225,25 @@ Instead, the process takes two deployments:
|
|
|
227
225
|
between the two stacks is being broken.
|
|
228
226
|
- Deploy (this will effectively only change the `consumerStack`, but it's safe to deploy both).
|
|
229
227
|
|
|
230
|
-
|
|
228
|
+
**Deployment 2: remove the bucket resource**:
|
|
231
229
|
|
|
232
230
|
- You are now free to remove the `bucket` resource from `producerStack`.
|
|
233
231
|
- Don't forget to remove the `exportValue()` call as well.
|
|
234
232
|
- Deploy again (this time only the `producerStack` will be changed -- the bucket will be deleted).
|
|
235
233
|
|
|
236
|
-
###### `exportedValue`<sup>Required</sup> <a name="exportedValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
234
|
+
###### `exportedValue`<sup>Required</sup> <a name="exportedValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportValue.parameter.exportedValue"></a>
|
|
237
235
|
|
|
238
236
|
- *Type:* any
|
|
239
237
|
|
|
240
238
|
---
|
|
241
239
|
|
|
242
|
-
###### `options`<sup>Optional</sup> <a name="options" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
240
|
+
###### `options`<sup>Optional</sup> <a name="options" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.exportValue.parameter.options"></a>
|
|
243
241
|
|
|
244
242
|
- *Type:* aws-cdk-lib.ExportValueOptions
|
|
245
243
|
|
|
246
244
|
---
|
|
247
245
|
|
|
248
|
-
##### `formatArn` <a name="formatArn" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
246
|
+
##### `formatArn` <a name="formatArn" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.formatArn"></a>
|
|
249
247
|
|
|
250
248
|
```typescript
|
|
251
249
|
public formatArn(components: ArnComponents): string
|
|
@@ -267,13 +265,13 @@ The required ARN pieces that are omitted will be taken from the stack that
|
|
|
267
265
|
the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope
|
|
268
266
|
can be 'undefined'.
|
|
269
267
|
|
|
270
|
-
###### `components`<sup>Required</sup> <a name="components" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
268
|
+
###### `components`<sup>Required</sup> <a name="components" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.formatArn.parameter.components"></a>
|
|
271
269
|
|
|
272
270
|
- *Type:* aws-cdk-lib.ArnComponents
|
|
273
271
|
|
|
274
272
|
---
|
|
275
273
|
|
|
276
|
-
##### `getLogicalId` <a name="getLogicalId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
274
|
+
##### `getLogicalId` <a name="getLogicalId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.getLogicalId"></a>
|
|
277
275
|
|
|
278
276
|
```typescript
|
|
279
277
|
public getLogicalId(element: CfnElement): string
|
|
@@ -289,7 +287,7 @@ This method uses the protected method `allocateLogicalId` to render the
|
|
|
289
287
|
logical ID for an element. To modify the naming scheme, extend the `Stack`
|
|
290
288
|
class and override this method.
|
|
291
289
|
|
|
292
|
-
###### `element`<sup>Required</sup> <a name="element" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
290
|
+
###### `element`<sup>Required</sup> <a name="element" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.getLogicalId.parameter.element"></a>
|
|
293
291
|
|
|
294
292
|
- *Type:* aws-cdk-lib.CfnElement
|
|
295
293
|
|
|
@@ -297,7 +295,7 @@ The CloudFormation element for which a logical identity is needed.
|
|
|
297
295
|
|
|
298
296
|
---
|
|
299
297
|
|
|
300
|
-
##### `regionalFact` <a name="regionalFact" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
298
|
+
##### `regionalFact` <a name="regionalFact" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.regionalFact"></a>
|
|
301
299
|
|
|
302
300
|
```typescript
|
|
303
301
|
public regionalFact(factName: string, defaultValue?: string): string
|
|
@@ -321,19 +319,19 @@ not have to worry about regional facts.
|
|
|
321
319
|
If `defaultValue` is not given, it is an error if the fact is unknown for
|
|
322
320
|
the given region.
|
|
323
321
|
|
|
324
|
-
###### `factName`<sup>Required</sup> <a name="factName" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
322
|
+
###### `factName`<sup>Required</sup> <a name="factName" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.regionalFact.parameter.factName"></a>
|
|
325
323
|
|
|
326
324
|
- *Type:* string
|
|
327
325
|
|
|
328
326
|
---
|
|
329
327
|
|
|
330
|
-
###### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
328
|
+
###### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.regionalFact.parameter.defaultValue"></a>
|
|
331
329
|
|
|
332
330
|
- *Type:* string
|
|
333
331
|
|
|
334
332
|
---
|
|
335
333
|
|
|
336
|
-
##### `renameLogicalId` <a name="renameLogicalId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
334
|
+
##### `renameLogicalId` <a name="renameLogicalId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.renameLogicalId"></a>
|
|
337
335
|
|
|
338
336
|
```typescript
|
|
339
337
|
public renameLogicalId(oldId: string, newId: string): void
|
|
@@ -344,19 +342,19 @@ Rename a generated logical identities.
|
|
|
344
342
|
To modify the naming scheme strategy, extend the `Stack` class and
|
|
345
343
|
override the `allocateLogicalId` method.
|
|
346
344
|
|
|
347
|
-
###### `oldId`<sup>Required</sup> <a name="oldId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
345
|
+
###### `oldId`<sup>Required</sup> <a name="oldId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.renameLogicalId.parameter.oldId"></a>
|
|
348
346
|
|
|
349
347
|
- *Type:* string
|
|
350
348
|
|
|
351
349
|
---
|
|
352
350
|
|
|
353
|
-
###### `newId`<sup>Required</sup> <a name="newId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
351
|
+
###### `newId`<sup>Required</sup> <a name="newId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.renameLogicalId.parameter.newId"></a>
|
|
354
352
|
|
|
355
353
|
- *Type:* string
|
|
356
354
|
|
|
357
355
|
---
|
|
358
356
|
|
|
359
|
-
##### `reportMissingContextKey` <a name="reportMissingContextKey" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
357
|
+
##### `reportMissingContextKey` <a name="reportMissingContextKey" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.reportMissingContextKey"></a>
|
|
360
358
|
|
|
361
359
|
```typescript
|
|
362
360
|
public reportMissingContextKey(report: MissingContext): void
|
|
@@ -367,7 +365,7 @@ Indicate that a context key was expected.
|
|
|
367
365
|
Contains instructions which will be emitted into the cloud assembly on how
|
|
368
366
|
the key should be supplied.
|
|
369
367
|
|
|
370
|
-
###### `report`<sup>Required</sup> <a name="report" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
368
|
+
###### `report`<sup>Required</sup> <a name="report" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.reportMissingContextKey.parameter.report"></a>
|
|
371
369
|
|
|
372
370
|
- *Type:* aws-cdk-lib.cloud_assembly_schema.MissingContext
|
|
373
371
|
|
|
@@ -375,7 +373,7 @@ The set of parameters needed to obtain the context.
|
|
|
375
373
|
|
|
376
374
|
---
|
|
377
375
|
|
|
378
|
-
##### `resolve` <a name="resolve" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
376
|
+
##### `resolve` <a name="resolve" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.resolve"></a>
|
|
379
377
|
|
|
380
378
|
```typescript
|
|
381
379
|
public resolve(obj: any): any
|
|
@@ -383,13 +381,13 @@ public resolve(obj: any): any
|
|
|
383
381
|
|
|
384
382
|
Resolve a tokenized value in the context of the current stack.
|
|
385
383
|
|
|
386
|
-
###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
384
|
+
###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.resolve.parameter.obj"></a>
|
|
387
385
|
|
|
388
386
|
- *Type:* any
|
|
389
387
|
|
|
390
388
|
---
|
|
391
389
|
|
|
392
|
-
##### `splitArn` <a name="splitArn" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
390
|
+
##### `splitArn` <a name="splitArn" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.splitArn"></a>
|
|
393
391
|
|
|
394
392
|
```typescript
|
|
395
393
|
public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents
|
|
@@ -402,7 +400,7 @@ and a Token representing a dynamic CloudFormation expression
|
|
|
402
400
|
(in which case the returned components will also be dynamic CloudFormation expressions,
|
|
403
401
|
encoded as Tokens).
|
|
404
402
|
|
|
405
|
-
###### `arn`<sup>Required</sup> <a name="arn" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
403
|
+
###### `arn`<sup>Required</sup> <a name="arn" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.splitArn.parameter.arn"></a>
|
|
406
404
|
|
|
407
405
|
- *Type:* string
|
|
408
406
|
|
|
@@ -410,7 +408,7 @@ the ARN to split into its components.
|
|
|
410
408
|
|
|
411
409
|
---
|
|
412
410
|
|
|
413
|
-
###### `arnFormat`<sup>Required</sup> <a name="arnFormat" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
411
|
+
###### `arnFormat`<sup>Required</sup> <a name="arnFormat" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.splitArn.parameter.arnFormat"></a>
|
|
414
412
|
|
|
415
413
|
- *Type:* aws-cdk-lib.ArnFormat
|
|
416
414
|
|
|
@@ -418,7 +416,7 @@ the expected format of 'arn' - depends on what format the service 'arn' represen
|
|
|
418
416
|
|
|
419
417
|
---
|
|
420
418
|
|
|
421
|
-
##### `toJsonString` <a name="toJsonString" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
419
|
+
##### `toJsonString` <a name="toJsonString" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toJsonString"></a>
|
|
422
420
|
|
|
423
421
|
```typescript
|
|
424
422
|
public toJsonString(obj: any, space?: number): string
|
|
@@ -426,19 +424,19 @@ public toJsonString(obj: any, space?: number): string
|
|
|
426
424
|
|
|
427
425
|
Convert an object, potentially containing tokens, to a JSON string.
|
|
428
426
|
|
|
429
|
-
###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
427
|
+
###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toJsonString.parameter.obj"></a>
|
|
430
428
|
|
|
431
429
|
- *Type:* any
|
|
432
430
|
|
|
433
431
|
---
|
|
434
432
|
|
|
435
|
-
###### `space`<sup>Optional</sup> <a name="space" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
433
|
+
###### `space`<sup>Optional</sup> <a name="space" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toJsonString.parameter.space"></a>
|
|
436
434
|
|
|
437
435
|
- *Type:* number
|
|
438
436
|
|
|
439
437
|
---
|
|
440
438
|
|
|
441
|
-
##### `toYamlString` <a name="toYamlString" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
439
|
+
##### `toYamlString` <a name="toYamlString" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toYamlString"></a>
|
|
442
440
|
|
|
443
441
|
```typescript
|
|
444
442
|
public toYamlString(obj: any): string
|
|
@@ -446,7 +444,7 @@ public toYamlString(obj: any): string
|
|
|
446
444
|
|
|
447
445
|
Convert an object, potentially containing tokens, to a YAML string.
|
|
448
446
|
|
|
449
|
-
###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
447
|
+
###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.toYamlString.parameter.obj"></a>
|
|
450
448
|
|
|
451
449
|
- *Type:* any
|
|
452
450
|
|
|
@@ -456,18 +454,18 @@ Convert an object, potentially containing tokens, to a YAML string.
|
|
|
456
454
|
|
|
457
455
|
| **Name** | **Description** |
|
|
458
456
|
| --- | --- |
|
|
459
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
460
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
461
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
457
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
458
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.isStack">isStack</a></code> | Return whether the given object is a Stack. |
|
|
459
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.of">of</a></code> | Looks up the first stack scope in which `construct` is defined. |
|
|
462
460
|
|
|
463
461
|
---
|
|
464
462
|
|
|
465
|
-
##### `isConstruct` <a name="isConstruct" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
463
|
+
##### `isConstruct` <a name="isConstruct" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.isConstruct"></a>
|
|
466
464
|
|
|
467
465
|
```typescript
|
|
468
|
-
import {
|
|
466
|
+
import { StepFunctionsExecutionStatusChangeNotificationStack } from '@gammarers/aws-stepfunctions-execution-status-change-notification-stack'
|
|
469
467
|
|
|
470
|
-
|
|
468
|
+
StepFunctionsExecutionStatusChangeNotificationStack.isConstruct(x: any)
|
|
471
469
|
```
|
|
472
470
|
|
|
473
471
|
Checks if `x` is a construct.
|
|
@@ -486,7 +484,7 @@ library can be accidentally installed, and `instanceof` will behave
|
|
|
486
484
|
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
487
485
|
this type-testing method instead.
|
|
488
486
|
|
|
489
|
-
###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
487
|
+
###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.isConstruct.parameter.x"></a>
|
|
490
488
|
|
|
491
489
|
- *Type:* any
|
|
492
490
|
|
|
@@ -494,37 +492,37 @@ Any object.
|
|
|
494
492
|
|
|
495
493
|
---
|
|
496
494
|
|
|
497
|
-
##### `isStack` <a name="isStack" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
495
|
+
##### `isStack` <a name="isStack" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.isStack"></a>
|
|
498
496
|
|
|
499
497
|
```typescript
|
|
500
|
-
import {
|
|
498
|
+
import { StepFunctionsExecutionStatusChangeNotificationStack } from '@gammarers/aws-stepfunctions-execution-status-change-notification-stack'
|
|
501
499
|
|
|
502
|
-
|
|
500
|
+
StepFunctionsExecutionStatusChangeNotificationStack.isStack(x: any)
|
|
503
501
|
```
|
|
504
502
|
|
|
505
503
|
Return whether the given object is a Stack.
|
|
506
504
|
|
|
507
505
|
We do attribute detection since we can't reliably use 'instanceof'.
|
|
508
506
|
|
|
509
|
-
###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
507
|
+
###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.isStack.parameter.x"></a>
|
|
510
508
|
|
|
511
509
|
- *Type:* any
|
|
512
510
|
|
|
513
511
|
---
|
|
514
512
|
|
|
515
|
-
##### `of` <a name="of" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
513
|
+
##### `of` <a name="of" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.of"></a>
|
|
516
514
|
|
|
517
515
|
```typescript
|
|
518
|
-
import {
|
|
516
|
+
import { StepFunctionsExecutionStatusChangeNotificationStack } from '@gammarers/aws-stepfunctions-execution-status-change-notification-stack'
|
|
519
517
|
|
|
520
|
-
|
|
518
|
+
StepFunctionsExecutionStatusChangeNotificationStack.of(construct: IConstruct)
|
|
521
519
|
```
|
|
522
520
|
|
|
523
521
|
Looks up the first stack scope in which `construct` is defined.
|
|
524
522
|
|
|
525
523
|
Fails if there is no stack up the tree.
|
|
526
524
|
|
|
527
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
525
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.of.parameter.construct"></a>
|
|
528
526
|
|
|
529
527
|
- *Type:* constructs.IConstruct
|
|
530
528
|
|
|
@@ -536,31 +534,31 @@ The construct to start the search from.
|
|
|
536
534
|
|
|
537
535
|
| **Name** | **Type** | **Description** |
|
|
538
536
|
| --- | --- | --- |
|
|
539
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
540
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
541
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
542
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
543
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
544
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
545
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
546
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
547
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
548
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
549
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
550
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
551
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
552
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
553
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
554
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
555
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
556
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
557
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
558
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
559
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
560
|
-
|
|
561
|
-
---
|
|
562
|
-
|
|
563
|
-
##### `node`<sup>Required</sup> <a name="node" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
537
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
538
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.account">account</a></code> | <code>string</code> | The AWS account into which this stack will be deployed. |
|
|
539
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.artifactId">artifactId</a></code> | <code>string</code> | The ID of the cloud assembly artifact for this stack. |
|
|
540
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.availabilityZones">availabilityZones</a></code> | <code>string[]</code> | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. |
|
|
541
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.bundlingRequired">bundlingRequired</a></code> | <code>boolean</code> | Indicates whether the stack requires bundling or not. |
|
|
542
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.dependencies">dependencies</a></code> | <code>aws-cdk-lib.Stack[]</code> | Return the stacks this stack depends on. |
|
|
543
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.environment">environment</a></code> | <code>string</code> | The environment coordinates in which this stack is deployed. |
|
|
544
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.nested">nested</a></code> | <code>boolean</code> | Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. |
|
|
545
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.notificationArns">notificationArns</a></code> | <code>string[]</code> | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. |
|
|
546
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.partition">partition</a></code> | <code>string</code> | The partition in which this stack is defined. |
|
|
547
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.region">region</a></code> | <code>string</code> | The AWS region into which this stack will be deployed (e.g. `us-west-2`). |
|
|
548
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.stackId">stackId</a></code> | <code>string</code> | The ID of the stack. |
|
|
549
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.stackName">stackName</a></code> | <code>string</code> | The concrete CloudFormation physical stack name. |
|
|
550
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.synthesizer">synthesizer</a></code> | <code>aws-cdk-lib.IStackSynthesizer</code> | Synthesis method for this stack. |
|
|
551
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | Tags to be applied to the stack. |
|
|
552
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.templateFile">templateFile</a></code> | <code>string</code> | The name of the CloudFormation template file emitted to the output directory during synthesis. |
|
|
553
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.templateOptions">templateOptions</a></code> | <code>aws-cdk-lib.ITemplateOptions</code> | Options for CloudFormation template (like version, transform, description). |
|
|
554
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.urlSuffix">urlSuffix</a></code> | <code>string</code> | The Amazon domain suffix for the region in which this stack is defined. |
|
|
555
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.nestedStackParent">nestedStackParent</a></code> | <code>aws-cdk-lib.Stack</code> | If this is a nested stack, returns it's parent stack. |
|
|
556
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.nestedStackResource">nestedStackResource</a></code> | <code>aws-cdk-lib.CfnResource</code> | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. |
|
|
557
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.terminationProtection">terminationProtection</a></code> | <code>boolean</code> | Whether termination protection is enabled for this stack. |
|
|
558
|
+
|
|
559
|
+
---
|
|
560
|
+
|
|
561
|
+
##### `node`<sup>Required</sup> <a name="node" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.node"></a>
|
|
564
562
|
|
|
565
563
|
```typescript
|
|
566
564
|
public readonly node: Node;
|
|
@@ -572,7 +570,7 @@ The tree node.
|
|
|
572
570
|
|
|
573
571
|
---
|
|
574
572
|
|
|
575
|
-
##### `account`<sup>Required</sup> <a name="account" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
573
|
+
##### `account`<sup>Required</sup> <a name="account" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.account"></a>
|
|
576
574
|
|
|
577
575
|
```typescript
|
|
578
576
|
public readonly account: string;
|
|
@@ -595,13 +593,13 @@ attempt to parse it to implement your logic. If you do, you must first
|
|
|
595
593
|
check that it is a concrete value an not an unresolved token. If this
|
|
596
594
|
value is an unresolved token (`Token.isUnresolved(stack.account)` returns
|
|
597
595
|
`true`), this implies that the user wishes that this stack will synthesize
|
|
598
|
-
into
|
|
596
|
+
into an **account-agnostic template**. In this case, your code should either
|
|
599
597
|
fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or
|
|
600
|
-
implement some other
|
|
598
|
+
implement some other account-agnostic behavior.
|
|
601
599
|
|
|
602
600
|
---
|
|
603
601
|
|
|
604
|
-
##### `artifactId`<sup>Required</sup> <a name="artifactId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
602
|
+
##### `artifactId`<sup>Required</sup> <a name="artifactId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.artifactId"></a>
|
|
605
603
|
|
|
606
604
|
```typescript
|
|
607
605
|
public readonly artifactId: string;
|
|
@@ -613,7 +611,7 @@ The ID of the cloud assembly artifact for this stack.
|
|
|
613
611
|
|
|
614
612
|
---
|
|
615
613
|
|
|
616
|
-
##### `availabilityZones`<sup>Required</sup> <a name="availabilityZones" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
614
|
+
##### `availabilityZones`<sup>Required</sup> <a name="availabilityZones" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.availabilityZones"></a>
|
|
617
615
|
|
|
618
616
|
```typescript
|
|
619
617
|
public readonly availabilityZones: string[];
|
|
@@ -636,7 +634,7 @@ To specify a different strategy for selecting availability zones override this m
|
|
|
636
634
|
|
|
637
635
|
---
|
|
638
636
|
|
|
639
|
-
##### `bundlingRequired`<sup>Required</sup> <a name="bundlingRequired" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
637
|
+
##### `bundlingRequired`<sup>Required</sup> <a name="bundlingRequired" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.bundlingRequired"></a>
|
|
640
638
|
|
|
641
639
|
```typescript
|
|
642
640
|
public readonly bundlingRequired: boolean;
|
|
@@ -648,7 +646,7 @@ Indicates whether the stack requires bundling or not.
|
|
|
648
646
|
|
|
649
647
|
---
|
|
650
648
|
|
|
651
|
-
##### `dependencies`<sup>Required</sup> <a name="dependencies" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
649
|
+
##### `dependencies`<sup>Required</sup> <a name="dependencies" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.dependencies"></a>
|
|
652
650
|
|
|
653
651
|
```typescript
|
|
654
652
|
public readonly dependencies: Stack[];
|
|
@@ -660,7 +658,7 @@ Return the stacks this stack depends on.
|
|
|
660
658
|
|
|
661
659
|
---
|
|
662
660
|
|
|
663
|
-
##### `environment`<sup>Required</sup> <a name="environment" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
661
|
+
##### `environment`<sup>Required</sup> <a name="environment" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.environment"></a>
|
|
664
662
|
|
|
665
663
|
```typescript
|
|
666
664
|
public readonly environment: string;
|
|
@@ -684,7 +682,7 @@ region/account-agnostic.
|
|
|
684
682
|
|
|
685
683
|
---
|
|
686
684
|
|
|
687
|
-
##### `nested`<sup>Required</sup> <a name="nested" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
685
|
+
##### `nested`<sup>Required</sup> <a name="nested" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.nested"></a>
|
|
688
686
|
|
|
689
687
|
```typescript
|
|
690
688
|
public readonly nested: boolean;
|
|
@@ -696,7 +694,7 @@ Indicates if this is a nested stack, in which case `parentStack` will include a
|
|
|
696
694
|
|
|
697
695
|
---
|
|
698
696
|
|
|
699
|
-
##### `notificationArns`<sup>Required</sup> <a name="notificationArns" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
697
|
+
##### `notificationArns`<sup>Required</sup> <a name="notificationArns" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.notificationArns"></a>
|
|
700
698
|
|
|
701
699
|
```typescript
|
|
702
700
|
public readonly notificationArns: string[];
|
|
@@ -708,7 +706,7 @@ Returns the list of notification Amazon Resource Names (ARNs) for the current st
|
|
|
708
706
|
|
|
709
707
|
---
|
|
710
708
|
|
|
711
|
-
##### `partition`<sup>Required</sup> <a name="partition" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
709
|
+
##### `partition`<sup>Required</sup> <a name="partition" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.partition"></a>
|
|
712
710
|
|
|
713
711
|
```typescript
|
|
714
712
|
public readonly partition: string;
|
|
@@ -720,7 +718,7 @@ The partition in which this stack is defined.
|
|
|
720
718
|
|
|
721
719
|
---
|
|
722
720
|
|
|
723
|
-
##### `region`<sup>Required</sup> <a name="region" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
721
|
+
##### `region`<sup>Required</sup> <a name="region" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.region"></a>
|
|
724
722
|
|
|
725
723
|
```typescript
|
|
726
724
|
public readonly region: string;
|
|
@@ -749,7 +747,7 @@ implement some other region-agnostic behavior.
|
|
|
749
747
|
|
|
750
748
|
---
|
|
751
749
|
|
|
752
|
-
##### `stackId`<sup>Required</sup> <a name="stackId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
750
|
+
##### `stackId`<sup>Required</sup> <a name="stackId" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.stackId"></a>
|
|
753
751
|
|
|
754
752
|
```typescript
|
|
755
753
|
public readonly stackId: string;
|
|
@@ -769,7 +767,7 @@ The ID of the stack.
|
|
|
769
767
|
```
|
|
770
768
|
|
|
771
769
|
|
|
772
|
-
##### `stackName`<sup>Required</sup> <a name="stackName" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
770
|
+
##### `stackName`<sup>Required</sup> <a name="stackName" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.stackName"></a>
|
|
773
771
|
|
|
774
772
|
```typescript
|
|
775
773
|
public readonly stackName: string;
|
|
@@ -790,7 +788,7 @@ you can use `Aws.STACK_NAME` directly.
|
|
|
790
788
|
|
|
791
789
|
---
|
|
792
790
|
|
|
793
|
-
##### `synthesizer`<sup>Required</sup> <a name="synthesizer" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
791
|
+
##### `synthesizer`<sup>Required</sup> <a name="synthesizer" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.synthesizer"></a>
|
|
794
792
|
|
|
795
793
|
```typescript
|
|
796
794
|
public readonly synthesizer: IStackSynthesizer;
|
|
@@ -802,7 +800,7 @@ Synthesis method for this stack.
|
|
|
802
800
|
|
|
803
801
|
---
|
|
804
802
|
|
|
805
|
-
##### `tags`<sup>Required</sup> <a name="tags" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
803
|
+
##### `tags`<sup>Required</sup> <a name="tags" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.tags"></a>
|
|
806
804
|
|
|
807
805
|
```typescript
|
|
808
806
|
public readonly tags: TagManager;
|
|
@@ -814,7 +812,7 @@ Tags to be applied to the stack.
|
|
|
814
812
|
|
|
815
813
|
---
|
|
816
814
|
|
|
817
|
-
##### `templateFile`<sup>Required</sup> <a name="templateFile" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
815
|
+
##### `templateFile`<sup>Required</sup> <a name="templateFile" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.templateFile"></a>
|
|
818
816
|
|
|
819
817
|
```typescript
|
|
820
818
|
public readonly templateFile: string;
|
|
@@ -828,7 +826,7 @@ Example value: `MyStack.template.json`
|
|
|
828
826
|
|
|
829
827
|
---
|
|
830
828
|
|
|
831
|
-
##### `templateOptions`<sup>Required</sup> <a name="templateOptions" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
829
|
+
##### `templateOptions`<sup>Required</sup> <a name="templateOptions" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.templateOptions"></a>
|
|
832
830
|
|
|
833
831
|
```typescript
|
|
834
832
|
public readonly templateOptions: ITemplateOptions;
|
|
@@ -840,7 +838,7 @@ Options for CloudFormation template (like version, transform, description).
|
|
|
840
838
|
|
|
841
839
|
---
|
|
842
840
|
|
|
843
|
-
##### `urlSuffix`<sup>Required</sup> <a name="urlSuffix" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
841
|
+
##### `urlSuffix`<sup>Required</sup> <a name="urlSuffix" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.urlSuffix"></a>
|
|
844
842
|
|
|
845
843
|
```typescript
|
|
846
844
|
public readonly urlSuffix: string;
|
|
@@ -852,7 +850,7 @@ The Amazon domain suffix for the region in which this stack is defined.
|
|
|
852
850
|
|
|
853
851
|
---
|
|
854
852
|
|
|
855
|
-
##### `nestedStackParent`<sup>Optional</sup> <a name="nestedStackParent" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
853
|
+
##### `nestedStackParent`<sup>Optional</sup> <a name="nestedStackParent" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.nestedStackParent"></a>
|
|
856
854
|
|
|
857
855
|
```typescript
|
|
858
856
|
public readonly nestedStackParent: Stack;
|
|
@@ -864,7 +862,7 @@ If this is a nested stack, returns it's parent stack.
|
|
|
864
862
|
|
|
865
863
|
---
|
|
866
864
|
|
|
867
|
-
##### `nestedStackResource`<sup>Optional</sup> <a name="nestedStackResource" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
865
|
+
##### `nestedStackResource`<sup>Optional</sup> <a name="nestedStackResource" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.nestedStackResource"></a>
|
|
868
866
|
|
|
869
867
|
```typescript
|
|
870
868
|
public readonly nestedStackResource: CfnResource;
|
|
@@ -878,7 +876,7 @@ If this is a nested stack, this represents its `AWS::CloudFormation::Stack` reso
|
|
|
878
876
|
|
|
879
877
|
---
|
|
880
878
|
|
|
881
|
-
##### `terminationProtection`<sup>Required</sup> <a name="terminationProtection" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
879
|
+
##### `terminationProtection`<sup>Required</sup> <a name="terminationProtection" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStack.property.terminationProtection"></a>
|
|
882
880
|
|
|
883
881
|
```typescript
|
|
884
882
|
public readonly terminationProtection: boolean;
|
|
@@ -921,37 +919,38 @@ public readonly emails: string[];
|
|
|
921
919
|
|
|
922
920
|
---
|
|
923
921
|
|
|
924
|
-
###
|
|
922
|
+
### StepFunctionsExecutionStatusChangeNotificationStackProps <a name="StepFunctionsExecutionStatusChangeNotificationStackProps" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps"></a>
|
|
925
923
|
|
|
926
|
-
#### Initializer <a name="Initializer" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
924
|
+
#### Initializer <a name="Initializer" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.Initializer"></a>
|
|
927
925
|
|
|
928
926
|
```typescript
|
|
929
|
-
import {
|
|
927
|
+
import { StepFunctionsExecutionStatusChangeNotificationStackProps } from '@gammarers/aws-stepfunctions-execution-status-change-notification-stack'
|
|
930
928
|
|
|
931
|
-
const
|
|
929
|
+
const stepFunctionsExecutionStatusChangeNotificationStackProps: StepFunctionsExecutionStatusChangeNotificationStackProps = { ... }
|
|
932
930
|
```
|
|
933
931
|
|
|
934
932
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
935
933
|
|
|
936
934
|
| **Name** | **Type** | **Description** |
|
|
937
935
|
| --- | --- | --- |
|
|
938
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
939
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
940
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
941
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
942
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
943
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
944
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
945
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
946
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
947
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
948
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
949
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
950
|
-
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
936
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.analyticsReporting">analyticsReporting</a></code> | <code>boolean</code> | Include runtime versioning information in this Stack. |
|
|
937
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.crossRegionReferences">crossRegionReferences</a></code> | <code>boolean</code> | Enable this flag to allow native cross region stack references. |
|
|
938
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.description">description</a></code> | <code>string</code> | A description of the stack. |
|
|
939
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.env">env</a></code> | <code>aws-cdk-lib.Environment</code> | The AWS environment (account/region) where this stack will be deployed. |
|
|
940
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.notificationArns">notificationArns</a></code> | <code>string[]</code> | SNS Topic ARNs that will receive stack events. |
|
|
941
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.permissionsBoundary">permissionsBoundary</a></code> | <code>aws-cdk-lib.PermissionsBoundary</code> | Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. |
|
|
942
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.stackName">stackName</a></code> | <code>string</code> | Name to deploy the stack with. |
|
|
943
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.suppressTemplateIndentation">suppressTemplateIndentation</a></code> | <code>boolean</code> | Enable this flag to suppress indentation in generated CloudFormation templates. |
|
|
944
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.synthesizer">synthesizer</a></code> | <code>aws-cdk-lib.IStackSynthesizer</code> | Synthesis method to use while deploying this stack. |
|
|
945
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.tags">tags</a></code> | <code>{[ key: string ]: string}</code> | Stack tags that will be applied to all the taggable resources and the stack itself. |
|
|
946
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.terminationProtection">terminationProtection</a></code> | <code>boolean</code> | Whether to enable termination protection for this stack. |
|
|
947
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.enableRule">enableRule</a></code> | <code>boolean</code> | *No description.* |
|
|
948
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.notifications">notifications</a></code> | <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.Notifications">Notifications</a></code> | *No description.* |
|
|
949
|
+
| <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.timeoutOption">timeoutOption</a></code> | <code><a href="#@gammarers/aws-stepfunctions-execution-status-change-notification-stack.TimeoutOption">TimeoutOption</a></code> | *No description.* |
|
|
951
950
|
|
|
952
951
|
---
|
|
953
952
|
|
|
954
|
-
##### `analyticsReporting`<sup>Optional</sup> <a name="analyticsReporting" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
953
|
+
##### `analyticsReporting`<sup>Optional</sup> <a name="analyticsReporting" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.analyticsReporting"></a>
|
|
955
954
|
|
|
956
955
|
```typescript
|
|
957
956
|
public readonly analyticsReporting: boolean;
|
|
@@ -964,7 +963,7 @@ Include runtime versioning information in this Stack.
|
|
|
964
963
|
|
|
965
964
|
---
|
|
966
965
|
|
|
967
|
-
##### `crossRegionReferences`<sup>Optional</sup> <a name="crossRegionReferences" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
966
|
+
##### `crossRegionReferences`<sup>Optional</sup> <a name="crossRegionReferences" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.crossRegionReferences"></a>
|
|
968
967
|
|
|
969
968
|
```typescript
|
|
970
969
|
public readonly crossRegionReferences: boolean;
|
|
@@ -982,7 +981,7 @@ This feature is currently experimental
|
|
|
982
981
|
|
|
983
982
|
---
|
|
984
983
|
|
|
985
|
-
##### `description`<sup>Optional</sup> <a name="description" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
984
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.description"></a>
|
|
986
985
|
|
|
987
986
|
```typescript
|
|
988
987
|
public readonly description: string;
|
|
@@ -995,7 +994,7 @@ A description of the stack.
|
|
|
995
994
|
|
|
996
995
|
---
|
|
997
996
|
|
|
998
|
-
##### `env`<sup>Optional</sup> <a name="env" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
997
|
+
##### `env`<sup>Optional</sup> <a name="env" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.env"></a>
|
|
999
998
|
|
|
1000
999
|
```typescript
|
|
1001
1000
|
public readonly env: Environment;
|
|
@@ -1069,7 +1068,20 @@ new MyStack(app, 'Stack1');
|
|
|
1069
1068
|
```
|
|
1070
1069
|
|
|
1071
1070
|
|
|
1072
|
-
##### `
|
|
1071
|
+
##### `notificationArns`<sup>Optional</sup> <a name="notificationArns" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.notificationArns"></a>
|
|
1072
|
+
|
|
1073
|
+
```typescript
|
|
1074
|
+
public readonly notificationArns: string[];
|
|
1075
|
+
```
|
|
1076
|
+
|
|
1077
|
+
- *Type:* string[]
|
|
1078
|
+
- *Default:* no notfication arns.
|
|
1079
|
+
|
|
1080
|
+
SNS Topic ARNs that will receive stack events.
|
|
1081
|
+
|
|
1082
|
+
---
|
|
1083
|
+
|
|
1084
|
+
##### `permissionsBoundary`<sup>Optional</sup> <a name="permissionsBoundary" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.permissionsBoundary"></a>
|
|
1073
1085
|
|
|
1074
1086
|
```typescript
|
|
1075
1087
|
public readonly permissionsBoundary: PermissionsBoundary;
|
|
@@ -1082,7 +1094,7 @@ Options for applying a permissions boundary to all IAM Roles and Users created w
|
|
|
1082
1094
|
|
|
1083
1095
|
---
|
|
1084
1096
|
|
|
1085
|
-
##### `stackName`<sup>Optional</sup> <a name="stackName" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1097
|
+
##### `stackName`<sup>Optional</sup> <a name="stackName" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.stackName"></a>
|
|
1086
1098
|
|
|
1087
1099
|
```typescript
|
|
1088
1100
|
public readonly stackName: string;
|
|
@@ -1095,7 +1107,7 @@ Name to deploy the stack with.
|
|
|
1095
1107
|
|
|
1096
1108
|
---
|
|
1097
1109
|
|
|
1098
|
-
##### `suppressTemplateIndentation`<sup>Optional</sup> <a name="suppressTemplateIndentation" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1110
|
+
##### `suppressTemplateIndentation`<sup>Optional</sup> <a name="suppressTemplateIndentation" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.suppressTemplateIndentation"></a>
|
|
1099
1111
|
|
|
1100
1112
|
```typescript
|
|
1101
1113
|
public readonly suppressTemplateIndentation: boolean;
|
|
@@ -1112,7 +1124,7 @@ default value `false` will be used.
|
|
|
1112
1124
|
|
|
1113
1125
|
---
|
|
1114
1126
|
|
|
1115
|
-
##### `synthesizer`<sup>Optional</sup> <a name="synthesizer" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1127
|
+
##### `synthesizer`<sup>Optional</sup> <a name="synthesizer" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.synthesizer"></a>
|
|
1116
1128
|
|
|
1117
1129
|
```typescript
|
|
1118
1130
|
public readonly synthesizer: IStackSynthesizer;
|
|
@@ -1135,7 +1147,7 @@ other synthesizer is specified.
|
|
|
1135
1147
|
|
|
1136
1148
|
---
|
|
1137
1149
|
|
|
1138
|
-
##### `tags`<sup>Optional</sup> <a name="tags" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1150
|
+
##### `tags`<sup>Optional</sup> <a name="tags" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.tags"></a>
|
|
1139
1151
|
|
|
1140
1152
|
```typescript
|
|
1141
1153
|
public readonly tags: {[ key: string ]: string};
|
|
@@ -1148,7 +1160,7 @@ Stack tags that will be applied to all the taggable resources and the stack itse
|
|
|
1148
1160
|
|
|
1149
1161
|
---
|
|
1150
1162
|
|
|
1151
|
-
##### `terminationProtection`<sup>Optional</sup> <a name="terminationProtection" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1163
|
+
##### `terminationProtection`<sup>Optional</sup> <a name="terminationProtection" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.terminationProtection"></a>
|
|
1152
1164
|
|
|
1153
1165
|
```typescript
|
|
1154
1166
|
public readonly terminationProtection: boolean;
|
|
@@ -1161,7 +1173,7 @@ Whether to enable termination protection for this stack.
|
|
|
1161
1173
|
|
|
1162
1174
|
---
|
|
1163
1175
|
|
|
1164
|
-
##### `enableRule`<sup>Optional</sup> <a name="enableRule" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1176
|
+
##### `enableRule`<sup>Optional</sup> <a name="enableRule" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.enableRule"></a>
|
|
1165
1177
|
|
|
1166
1178
|
```typescript
|
|
1167
1179
|
public readonly enableRule: boolean;
|
|
@@ -1171,7 +1183,7 @@ public readonly enableRule: boolean;
|
|
|
1171
1183
|
|
|
1172
1184
|
---
|
|
1173
1185
|
|
|
1174
|
-
##### `notifications`<sup>Optional</sup> <a name="notifications" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1186
|
+
##### `notifications`<sup>Optional</sup> <a name="notifications" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.notifications"></a>
|
|
1175
1187
|
|
|
1176
1188
|
```typescript
|
|
1177
1189
|
public readonly notifications: Notifications;
|
|
@@ -1181,7 +1193,7 @@ public readonly notifications: Notifications;
|
|
|
1181
1193
|
|
|
1182
1194
|
---
|
|
1183
1195
|
|
|
1184
|
-
##### `timeoutOption`<sup>Optional</sup> <a name="timeoutOption" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.
|
|
1196
|
+
##### `timeoutOption`<sup>Optional</sup> <a name="timeoutOption" id="@gammarers/aws-stepfunctions-execution-status-change-notification-stack.StepFunctionsExecutionStatusChangeNotificationStackProps.property.timeoutOption"></a>
|
|
1185
1197
|
|
|
1186
1198
|
```typescript
|
|
1187
1199
|
public readonly timeoutOption: TimeoutOption;
|