@gammarers/aws-codesuite-state-change-detection-event-rules 2.2.30 → 2.3.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/.jsii +173 -21
- package/API.md +616 -30
- package/lib/codepipeline-execution-state-change-detection-event-rule.d.ts +9 -0
- package/lib/codepipeline-execution-state-change-detection-event-rule.js +8 -2
- package/lib/codepipeline-pipeline-execution-state-change-detection-event-rule.d.ts +24 -0
- package/lib/codepipeline-pipeline-execution-state-change-detection-event-rule.js +52 -0
- package/lib/codepipeline-stage-execution-state-change-detection-event-rule.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/package.json +5 -5
package/API.md
CHANGED
|
@@ -49,7 +49,7 @@ new CodePipelineExecutionStateChangeDetectionEventRule(scope: Construct, id: str
|
|
|
49
49
|
|
|
50
50
|
---
|
|
51
51
|
|
|
52
|
-
#####
|
|
52
|
+
##### ~~`toString`~~ <a name="toString" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.toString"></a>
|
|
53
53
|
|
|
54
54
|
```typescript
|
|
55
55
|
public toString(): string
|
|
@@ -57,7 +57,7 @@ public toString(): string
|
|
|
57
57
|
|
|
58
58
|
Returns a string representation of this construct.
|
|
59
59
|
|
|
60
|
-
#####
|
|
60
|
+
##### ~~`applyRemovalPolicy`~~ <a name="applyRemovalPolicy" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.applyRemovalPolicy"></a>
|
|
61
61
|
|
|
62
62
|
```typescript
|
|
63
63
|
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
@@ -79,7 +79,7 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
|
79
79
|
|
|
80
80
|
---
|
|
81
81
|
|
|
82
|
-
#####
|
|
82
|
+
##### ~~`addEventPattern`~~ <a name="addEventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.addEventPattern"></a>
|
|
83
83
|
|
|
84
84
|
```typescript
|
|
85
85
|
public addEventPattern(eventPattern?: EventPattern): void
|
|
@@ -124,7 +124,7 @@ The resulting event pattern will be:
|
|
|
124
124
|
|
|
125
125
|
---
|
|
126
126
|
|
|
127
|
-
#####
|
|
127
|
+
##### ~~`addTarget`~~ <a name="addTarget" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.addTarget"></a>
|
|
128
128
|
|
|
129
129
|
```typescript
|
|
130
130
|
public addTarget(target?: IRuleTarget): void
|
|
@@ -151,7 +151,7 @@ No-op if target is undefined.
|
|
|
151
151
|
|
|
152
152
|
---
|
|
153
153
|
|
|
154
|
-
#####
|
|
154
|
+
##### ~~`isConstruct`~~ <a name="isConstruct" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.isConstruct"></a>
|
|
155
155
|
|
|
156
156
|
```typescript
|
|
157
157
|
import { CodePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
@@ -183,7 +183,7 @@ Any object.
|
|
|
183
183
|
|
|
184
184
|
---
|
|
185
185
|
|
|
186
|
-
#####
|
|
186
|
+
##### ~~`isOwnedResource`~~ <a name="isOwnedResource" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.isOwnedResource"></a>
|
|
187
187
|
|
|
188
188
|
```typescript
|
|
189
189
|
import { CodePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
@@ -199,7 +199,7 @@ Returns true if the construct was created by CDK, and false otherwise.
|
|
|
199
199
|
|
|
200
200
|
---
|
|
201
201
|
|
|
202
|
-
#####
|
|
202
|
+
##### ~~`isResource`~~ <a name="isResource" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.isResource"></a>
|
|
203
203
|
|
|
204
204
|
```typescript
|
|
205
205
|
import { CodePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
@@ -215,7 +215,7 @@ Check whether the given construct is a Resource.
|
|
|
215
215
|
|
|
216
216
|
---
|
|
217
217
|
|
|
218
|
-
#####
|
|
218
|
+
##### ~~`fromEventRuleArn`~~ <a name="fromEventRuleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.fromEventRuleArn"></a>
|
|
219
219
|
|
|
220
220
|
```typescript
|
|
221
221
|
import { CodePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
@@ -261,7 +261,9 @@ Event Rule ARN (i.e. arn:aws:events:<region>:<account-id>:rule/MyScheduledRule).
|
|
|
261
261
|
|
|
262
262
|
---
|
|
263
263
|
|
|
264
|
-
#####
|
|
264
|
+
##### ~~`node`~~<sup>Required</sup> <a name="node" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.property.node"></a>
|
|
265
|
+
|
|
266
|
+
- *Deprecated:* This class is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRule class instead.
|
|
265
267
|
|
|
266
268
|
```typescript
|
|
267
269
|
public readonly node: Node;
|
|
@@ -273,7 +275,9 @@ The tree node.
|
|
|
273
275
|
|
|
274
276
|
---
|
|
275
277
|
|
|
276
|
-
#####
|
|
278
|
+
##### ~~`env`~~<sup>Required</sup> <a name="env" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.property.env"></a>
|
|
279
|
+
|
|
280
|
+
- *Deprecated:* This class is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRule class instead.
|
|
277
281
|
|
|
278
282
|
```typescript
|
|
279
283
|
public readonly env: ResourceEnvironment;
|
|
@@ -292,7 +296,9 @@ that might be different than the stack they were imported into.
|
|
|
292
296
|
|
|
293
297
|
---
|
|
294
298
|
|
|
295
|
-
#####
|
|
299
|
+
##### ~~`stack`~~<sup>Required</sup> <a name="stack" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.property.stack"></a>
|
|
300
|
+
|
|
301
|
+
- *Deprecated:* This class is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRule class instead.
|
|
296
302
|
|
|
297
303
|
```typescript
|
|
298
304
|
public readonly stack: Stack;
|
|
@@ -304,7 +310,9 @@ The stack in which this resource is defined.
|
|
|
304
310
|
|
|
305
311
|
---
|
|
306
312
|
|
|
307
|
-
#####
|
|
313
|
+
##### ~~`ruleArn`~~<sup>Required</sup> <a name="ruleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.property.ruleArn"></a>
|
|
314
|
+
|
|
315
|
+
- *Deprecated:* This class is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRule class instead.
|
|
308
316
|
|
|
309
317
|
```typescript
|
|
310
318
|
public readonly ruleArn: string;
|
|
@@ -316,7 +324,336 @@ The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:u
|
|
|
316
324
|
|
|
317
325
|
---
|
|
318
326
|
|
|
319
|
-
#####
|
|
327
|
+
##### ~~`ruleName`~~<sup>Required</sup> <a name="ruleName" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule.property.ruleName"></a>
|
|
328
|
+
|
|
329
|
+
- *Deprecated:* This class is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRule class instead.
|
|
330
|
+
|
|
331
|
+
```typescript
|
|
332
|
+
public readonly ruleName: string;
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
- *Type:* string
|
|
336
|
+
|
|
337
|
+
The name event rule.
|
|
338
|
+
|
|
339
|
+
---
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
### CodePipelinePipelineExecutionStateChangeDetectionEventRule <a name="CodePipelinePipelineExecutionStateChangeDetectionEventRule" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule"></a>
|
|
343
|
+
|
|
344
|
+
#### Initializers <a name="Initializers" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.Initializer"></a>
|
|
345
|
+
|
|
346
|
+
```typescript
|
|
347
|
+
import { CodePipelinePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
348
|
+
|
|
349
|
+
new CodePipelinePipelineExecutionStateChangeDetectionEventRule(scope: Construct, id: string, props: CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps)
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
| **Name** | **Type** | **Description** |
|
|
353
|
+
| --- | --- | --- |
|
|
354
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
355
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
356
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.Initializer.parameter.props">props</a></code> | <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps">CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps</a></code> | *No description.* |
|
|
357
|
+
|
|
358
|
+
---
|
|
359
|
+
|
|
360
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.Initializer.parameter.scope"></a>
|
|
361
|
+
|
|
362
|
+
- *Type:* constructs.Construct
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
##### `id`<sup>Required</sup> <a name="id" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.Initializer.parameter.id"></a>
|
|
367
|
+
|
|
368
|
+
- *Type:* string
|
|
369
|
+
|
|
370
|
+
---
|
|
371
|
+
|
|
372
|
+
##### `props`<sup>Required</sup> <a name="props" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.Initializer.parameter.props"></a>
|
|
373
|
+
|
|
374
|
+
- *Type:* <a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps">CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps</a>
|
|
375
|
+
|
|
376
|
+
---
|
|
377
|
+
|
|
378
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
379
|
+
|
|
380
|
+
| **Name** | **Description** |
|
|
381
|
+
| --- | --- |
|
|
382
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
383
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
384
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.addEventPattern">addEventPattern</a></code> | Adds an event pattern filter to this rule. |
|
|
385
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.addTarget">addTarget</a></code> | Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets. |
|
|
386
|
+
|
|
387
|
+
---
|
|
388
|
+
|
|
389
|
+
##### `toString` <a name="toString" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.toString"></a>
|
|
390
|
+
|
|
391
|
+
```typescript
|
|
392
|
+
public toString(): string
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
Returns a string representation of this construct.
|
|
396
|
+
|
|
397
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.applyRemovalPolicy"></a>
|
|
398
|
+
|
|
399
|
+
```typescript
|
|
400
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
Apply the given removal policy to this resource.
|
|
404
|
+
|
|
405
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
406
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
407
|
+
CDK application or because you've made a change that requires the resource
|
|
408
|
+
to be replaced.
|
|
409
|
+
|
|
410
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
411
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
412
|
+
|
|
413
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.applyRemovalPolicy.parameter.policy"></a>
|
|
414
|
+
|
|
415
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
416
|
+
|
|
417
|
+
---
|
|
418
|
+
|
|
419
|
+
##### `addEventPattern` <a name="addEventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.addEventPattern"></a>
|
|
420
|
+
|
|
421
|
+
```typescript
|
|
422
|
+
public addEventPattern(eventPattern?: EventPattern): void
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
Adds an event pattern filter to this rule.
|
|
426
|
+
|
|
427
|
+
If a pattern was already specified,
|
|
428
|
+
these values are merged into the existing pattern.
|
|
429
|
+
|
|
430
|
+
For example, if the rule already contains the pattern:
|
|
431
|
+
|
|
432
|
+
{
|
|
433
|
+
"resources": [ "r1" ],
|
|
434
|
+
"detail": {
|
|
435
|
+
"hello": [ 1 ]
|
|
436
|
+
}
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
And `addEventPattern` is called with the pattern:
|
|
440
|
+
|
|
441
|
+
{
|
|
442
|
+
"resources": [ "r2" ],
|
|
443
|
+
"detail": {
|
|
444
|
+
"foo": [ "bar" ]
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
The resulting event pattern will be:
|
|
449
|
+
|
|
450
|
+
{
|
|
451
|
+
"resources": [ "r1", "r2" ],
|
|
452
|
+
"detail": {
|
|
453
|
+
"hello": [ 1 ],
|
|
454
|
+
"foo": [ "bar" ]
|
|
455
|
+
}
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
###### `eventPattern`<sup>Optional</sup> <a name="eventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.addEventPattern.parameter.eventPattern"></a>
|
|
459
|
+
|
|
460
|
+
- *Type:* aws-cdk-lib.aws_events.EventPattern
|
|
461
|
+
|
|
462
|
+
---
|
|
463
|
+
|
|
464
|
+
##### `addTarget` <a name="addTarget" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.addTarget"></a>
|
|
465
|
+
|
|
466
|
+
```typescript
|
|
467
|
+
public addTarget(target?: IRuleTarget): void
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.
|
|
471
|
+
|
|
472
|
+
No-op if target is undefined.
|
|
473
|
+
|
|
474
|
+
###### `target`<sup>Optional</sup> <a name="target" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.addTarget.parameter.target"></a>
|
|
475
|
+
|
|
476
|
+
- *Type:* aws-cdk-lib.aws_events.IRuleTarget
|
|
477
|
+
|
|
478
|
+
---
|
|
479
|
+
|
|
480
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
481
|
+
|
|
482
|
+
| **Name** | **Description** |
|
|
483
|
+
| --- | --- |
|
|
484
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
485
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
486
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
487
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.fromEventRuleArn">fromEventRuleArn</a></code> | Import an existing EventBridge Rule provided an ARN. |
|
|
488
|
+
|
|
489
|
+
---
|
|
490
|
+
|
|
491
|
+
##### `isConstruct` <a name="isConstruct" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isConstruct"></a>
|
|
492
|
+
|
|
493
|
+
```typescript
|
|
494
|
+
import { CodePipelinePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
495
|
+
|
|
496
|
+
CodePipelinePipelineExecutionStateChangeDetectionEventRule.isConstruct(x: any)
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
Checks if `x` is a construct.
|
|
500
|
+
|
|
501
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
502
|
+
instances, even when the construct library is symlinked.
|
|
503
|
+
|
|
504
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
505
|
+
disk are seen as independent, completely different libraries. As a
|
|
506
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
507
|
+
is seen as a different class, and an instance of one class will not test as
|
|
508
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
509
|
+
like this, but users may manually symlink construct libraries together or
|
|
510
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
511
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
512
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
513
|
+
this type-testing method instead.
|
|
514
|
+
|
|
515
|
+
###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isConstruct.parameter.x"></a>
|
|
516
|
+
|
|
517
|
+
- *Type:* any
|
|
518
|
+
|
|
519
|
+
Any object.
|
|
520
|
+
|
|
521
|
+
---
|
|
522
|
+
|
|
523
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isOwnedResource"></a>
|
|
524
|
+
|
|
525
|
+
```typescript
|
|
526
|
+
import { CodePipelinePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
527
|
+
|
|
528
|
+
CodePipelinePipelineExecutionStateChangeDetectionEventRule.isOwnedResource(construct: IConstruct)
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
532
|
+
|
|
533
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isOwnedResource.parameter.construct"></a>
|
|
534
|
+
|
|
535
|
+
- *Type:* constructs.IConstruct
|
|
536
|
+
|
|
537
|
+
---
|
|
538
|
+
|
|
539
|
+
##### `isResource` <a name="isResource" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isResource"></a>
|
|
540
|
+
|
|
541
|
+
```typescript
|
|
542
|
+
import { CodePipelinePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
543
|
+
|
|
544
|
+
CodePipelinePipelineExecutionStateChangeDetectionEventRule.isResource(construct: IConstruct)
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
Check whether the given construct is a Resource.
|
|
548
|
+
|
|
549
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.isResource.parameter.construct"></a>
|
|
550
|
+
|
|
551
|
+
- *Type:* constructs.IConstruct
|
|
552
|
+
|
|
553
|
+
---
|
|
554
|
+
|
|
555
|
+
##### `fromEventRuleArn` <a name="fromEventRuleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.fromEventRuleArn"></a>
|
|
556
|
+
|
|
557
|
+
```typescript
|
|
558
|
+
import { CodePipelinePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
559
|
+
|
|
560
|
+
CodePipelinePipelineExecutionStateChangeDetectionEventRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
Import an existing EventBridge Rule provided an ARN.
|
|
564
|
+
|
|
565
|
+
###### `scope`<sup>Required</sup> <a name="scope" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.fromEventRuleArn.parameter.scope"></a>
|
|
566
|
+
|
|
567
|
+
- *Type:* constructs.Construct
|
|
568
|
+
|
|
569
|
+
The parent creating construct (usually `this`).
|
|
570
|
+
|
|
571
|
+
---
|
|
572
|
+
|
|
573
|
+
###### `id`<sup>Required</sup> <a name="id" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.fromEventRuleArn.parameter.id"></a>
|
|
574
|
+
|
|
575
|
+
- *Type:* string
|
|
576
|
+
|
|
577
|
+
The construct's name.
|
|
578
|
+
|
|
579
|
+
---
|
|
580
|
+
|
|
581
|
+
###### `eventRuleArn`<sup>Required</sup> <a name="eventRuleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.fromEventRuleArn.parameter.eventRuleArn"></a>
|
|
582
|
+
|
|
583
|
+
- *Type:* string
|
|
584
|
+
|
|
585
|
+
Event Rule ARN (i.e. arn:aws:events:<region>:<account-id>:rule/MyScheduledRule).
|
|
586
|
+
|
|
587
|
+
---
|
|
588
|
+
|
|
589
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
590
|
+
|
|
591
|
+
| **Name** | **Type** | **Description** |
|
|
592
|
+
| --- | --- | --- |
|
|
593
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
594
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
595
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
596
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.ruleArn">ruleArn</a></code> | <code>string</code> | The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example. |
|
|
597
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.ruleName">ruleName</a></code> | <code>string</code> | The name event rule. |
|
|
598
|
+
|
|
599
|
+
---
|
|
600
|
+
|
|
601
|
+
##### `node`<sup>Required</sup> <a name="node" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.node"></a>
|
|
602
|
+
|
|
603
|
+
```typescript
|
|
604
|
+
public readonly node: Node;
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
- *Type:* constructs.Node
|
|
608
|
+
|
|
609
|
+
The tree node.
|
|
610
|
+
|
|
611
|
+
---
|
|
612
|
+
|
|
613
|
+
##### `env`<sup>Required</sup> <a name="env" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.env"></a>
|
|
614
|
+
|
|
615
|
+
```typescript
|
|
616
|
+
public readonly env: ResourceEnvironment;
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
620
|
+
|
|
621
|
+
The environment this resource belongs to.
|
|
622
|
+
|
|
623
|
+
For resources that are created and managed by the CDK
|
|
624
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
625
|
+
this is always the same as the environment of the stack they belong to;
|
|
626
|
+
however, for imported resources
|
|
627
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
628
|
+
that might be different than the stack they were imported into.
|
|
629
|
+
|
|
630
|
+
---
|
|
631
|
+
|
|
632
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.stack"></a>
|
|
633
|
+
|
|
634
|
+
```typescript
|
|
635
|
+
public readonly stack: Stack;
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
- *Type:* aws-cdk-lib.Stack
|
|
639
|
+
|
|
640
|
+
The stack in which this resource is defined.
|
|
641
|
+
|
|
642
|
+
---
|
|
643
|
+
|
|
644
|
+
##### `ruleArn`<sup>Required</sup> <a name="ruleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.ruleArn"></a>
|
|
645
|
+
|
|
646
|
+
```typescript
|
|
647
|
+
public readonly ruleArn: string;
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
- *Type:* string
|
|
651
|
+
|
|
652
|
+
The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
|
|
653
|
+
|
|
654
|
+
---
|
|
655
|
+
|
|
656
|
+
##### `ruleName`<sup>Required</sup> <a name="ruleName" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRule.property.ruleName"></a>
|
|
320
657
|
|
|
321
658
|
```typescript
|
|
322
659
|
public readonly ruleName: string;
|
|
@@ -684,7 +1021,9 @@ const codePipelineExecutionStateChangeDetectionEventRuleProps: CodePipelineExecu
|
|
|
684
1021
|
|
|
685
1022
|
---
|
|
686
1023
|
|
|
687
|
-
#####
|
|
1024
|
+
##### ~~`crossStackScope`~~<sup>Optional</sup> <a name="crossStackScope" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.crossStackScope"></a>
|
|
1025
|
+
|
|
1026
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
688
1027
|
|
|
689
1028
|
```typescript
|
|
690
1029
|
public readonly crossStackScope: Construct;
|
|
@@ -699,7 +1038,9 @@ This helps dealing with cycles that often arise in these situations.
|
|
|
699
1038
|
|
|
700
1039
|
---
|
|
701
1040
|
|
|
702
|
-
#####
|
|
1041
|
+
##### ~~`description`~~<sup>Optional</sup> <a name="description" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.description"></a>
|
|
1042
|
+
|
|
1043
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
703
1044
|
|
|
704
1045
|
```typescript
|
|
705
1046
|
public readonly description: string;
|
|
@@ -712,7 +1053,9 @@ A description of the rule's purpose.
|
|
|
712
1053
|
|
|
713
1054
|
---
|
|
714
1055
|
|
|
715
|
-
#####
|
|
1056
|
+
##### ~~`eventPattern`~~<sup>Optional</sup> <a name="eventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.eventPattern"></a>
|
|
1057
|
+
|
|
1058
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
716
1059
|
|
|
717
1060
|
```typescript
|
|
718
1061
|
public readonly eventPattern: EventPattern;
|
|
@@ -731,7 +1074,9 @@ on top of that filtering.
|
|
|
731
1074
|
|
|
732
1075
|
---
|
|
733
1076
|
|
|
734
|
-
#####
|
|
1077
|
+
##### ~~`ruleName`~~<sup>Optional</sup> <a name="ruleName" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.ruleName"></a>
|
|
1078
|
+
|
|
1079
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
735
1080
|
|
|
736
1081
|
```typescript
|
|
737
1082
|
public readonly ruleName: string;
|
|
@@ -744,7 +1089,9 @@ A name for the rule.
|
|
|
744
1089
|
|
|
745
1090
|
---
|
|
746
1091
|
|
|
747
|
-
#####
|
|
1092
|
+
##### ~~`enabled`~~<sup>Optional</sup> <a name="enabled" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.enabled"></a>
|
|
1093
|
+
|
|
1094
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
748
1095
|
|
|
749
1096
|
```typescript
|
|
750
1097
|
public readonly enabled: boolean;
|
|
@@ -757,7 +1104,9 @@ Indicates whether the rule is enabled.
|
|
|
757
1104
|
|
|
758
1105
|
---
|
|
759
1106
|
|
|
760
|
-
#####
|
|
1107
|
+
##### ~~`eventBus`~~<sup>Optional</sup> <a name="eventBus" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.eventBus"></a>
|
|
1108
|
+
|
|
1109
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
761
1110
|
|
|
762
1111
|
```typescript
|
|
763
1112
|
public readonly eventBus: IEventBus;
|
|
@@ -770,7 +1119,9 @@ The event bus to associate with this rule.
|
|
|
770
1119
|
|
|
771
1120
|
---
|
|
772
1121
|
|
|
773
|
-
#####
|
|
1122
|
+
##### ~~`schedule`~~<sup>Optional</sup> <a name="schedule" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.schedule"></a>
|
|
1123
|
+
|
|
1124
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
774
1125
|
|
|
775
1126
|
```typescript
|
|
776
1127
|
public readonly schedule: Schedule;
|
|
@@ -790,7 +1141,9 @@ Rules in the Amazon EventBridge User Guide.
|
|
|
790
1141
|
|
|
791
1142
|
---
|
|
792
1143
|
|
|
793
|
-
#####
|
|
1144
|
+
##### ~~`targets`~~<sup>Optional</sup> <a name="targets" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.targets"></a>
|
|
1145
|
+
|
|
1146
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
794
1147
|
|
|
795
1148
|
```typescript
|
|
796
1149
|
public readonly targets: IRuleTarget[];
|
|
@@ -806,7 +1159,9 @@ target input, use `addTarget(target[, inputOptions])`.
|
|
|
806
1159
|
|
|
807
1160
|
---
|
|
808
1161
|
|
|
809
|
-
#####
|
|
1162
|
+
##### ~~`targetStates`~~<sup>Optional</sup> <a name="targetStates" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps.property.targetStates"></a>
|
|
1163
|
+
|
|
1164
|
+
- *Deprecated:* This interface is deprecated. Use the CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps interface instead.
|
|
810
1165
|
|
|
811
1166
|
```typescript
|
|
812
1167
|
public readonly targetStates: CodePipelineExecutionState[];
|
|
@@ -816,6 +1171,164 @@ public readonly targetStates: CodePipelineExecutionState[];
|
|
|
816
1171
|
|
|
817
1172
|
---
|
|
818
1173
|
|
|
1174
|
+
### CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps <a name="CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps"></a>
|
|
1175
|
+
|
|
1176
|
+
#### Initializer <a name="Initializer" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.Initializer"></a>
|
|
1177
|
+
|
|
1178
|
+
```typescript
|
|
1179
|
+
import { CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
|
|
1180
|
+
|
|
1181
|
+
const codePipelinePipelineExecutionStateChangeDetectionEventRuleProps: CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps = { ... }
|
|
1182
|
+
```
|
|
1183
|
+
|
|
1184
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1185
|
+
|
|
1186
|
+
| **Name** | **Type** | **Description** |
|
|
1187
|
+
| --- | --- | --- |
|
|
1188
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.crossStackScope">crossStackScope</a></code> | <code>constructs.Construct</code> | The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). |
|
|
1189
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.description">description</a></code> | <code>string</code> | A description of the rule's purpose. |
|
|
1190
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.eventPattern">eventPattern</a></code> | <code>aws-cdk-lib.aws_events.EventPattern</code> | Additional restrictions for the event to route to the specified target. |
|
|
1191
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.ruleName">ruleName</a></code> | <code>string</code> | A name for the rule. |
|
|
1192
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.enabled">enabled</a></code> | <code>boolean</code> | Indicates whether the rule is enabled. |
|
|
1193
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.eventBus">eventBus</a></code> | <code>aws-cdk-lib.aws_events.IEventBus</code> | The event bus to associate with this rule. |
|
|
1194
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.schedule">schedule</a></code> | <code>aws-cdk-lib.aws_events.Schedule</code> | The schedule or rate (frequency) that determines when EventBridge runs the rule. |
|
|
1195
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.targets">targets</a></code> | <code>aws-cdk-lib.aws_events.IRuleTarget[]</code> | Targets to invoke when this rule matches an event. |
|
|
1196
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.targetStates">targetStates</a></code> | <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState">CodePipelinePipelineExecutionState</a>[]</code> | *No description.* |
|
|
1197
|
+
|
|
1198
|
+
---
|
|
1199
|
+
|
|
1200
|
+
##### `crossStackScope`<sup>Optional</sup> <a name="crossStackScope" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.crossStackScope"></a>
|
|
1201
|
+
|
|
1202
|
+
```typescript
|
|
1203
|
+
public readonly crossStackScope: Construct;
|
|
1204
|
+
```
|
|
1205
|
+
|
|
1206
|
+
- *Type:* constructs.Construct
|
|
1207
|
+
- *Default:* none (the main scope will be used, even for cross-stack Events)
|
|
1208
|
+
|
|
1209
|
+
The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
|
|
1210
|
+
|
|
1211
|
+
This helps dealing with cycles that often arise in these situations.
|
|
1212
|
+
|
|
1213
|
+
---
|
|
1214
|
+
|
|
1215
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.description"></a>
|
|
1216
|
+
|
|
1217
|
+
```typescript
|
|
1218
|
+
public readonly description: string;
|
|
1219
|
+
```
|
|
1220
|
+
|
|
1221
|
+
- *Type:* string
|
|
1222
|
+
- *Default:* No description
|
|
1223
|
+
|
|
1224
|
+
A description of the rule's purpose.
|
|
1225
|
+
|
|
1226
|
+
---
|
|
1227
|
+
|
|
1228
|
+
##### `eventPattern`<sup>Optional</sup> <a name="eventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.eventPattern"></a>
|
|
1229
|
+
|
|
1230
|
+
```typescript
|
|
1231
|
+
public readonly eventPattern: EventPattern;
|
|
1232
|
+
```
|
|
1233
|
+
|
|
1234
|
+
- *Type:* aws-cdk-lib.aws_events.EventPattern
|
|
1235
|
+
- *Default:* No additional filtering based on an event pattern.
|
|
1236
|
+
|
|
1237
|
+
Additional restrictions for the event to route to the specified target.
|
|
1238
|
+
|
|
1239
|
+
The method that generates the rule probably imposes some type of event
|
|
1240
|
+
filtering. The filtering implied by what you pass here is added
|
|
1241
|
+
on top of that filtering.
|
|
1242
|
+
|
|
1243
|
+
> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
|
|
1244
|
+
|
|
1245
|
+
---
|
|
1246
|
+
|
|
1247
|
+
##### `ruleName`<sup>Optional</sup> <a name="ruleName" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.ruleName"></a>
|
|
1248
|
+
|
|
1249
|
+
```typescript
|
|
1250
|
+
public readonly ruleName: string;
|
|
1251
|
+
```
|
|
1252
|
+
|
|
1253
|
+
- *Type:* string
|
|
1254
|
+
- *Default:* AWS CloudFormation generates a unique physical ID.
|
|
1255
|
+
|
|
1256
|
+
A name for the rule.
|
|
1257
|
+
|
|
1258
|
+
---
|
|
1259
|
+
|
|
1260
|
+
##### `enabled`<sup>Optional</sup> <a name="enabled" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.enabled"></a>
|
|
1261
|
+
|
|
1262
|
+
```typescript
|
|
1263
|
+
public readonly enabled: boolean;
|
|
1264
|
+
```
|
|
1265
|
+
|
|
1266
|
+
- *Type:* boolean
|
|
1267
|
+
- *Default:* true
|
|
1268
|
+
|
|
1269
|
+
Indicates whether the rule is enabled.
|
|
1270
|
+
|
|
1271
|
+
---
|
|
1272
|
+
|
|
1273
|
+
##### `eventBus`<sup>Optional</sup> <a name="eventBus" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.eventBus"></a>
|
|
1274
|
+
|
|
1275
|
+
```typescript
|
|
1276
|
+
public readonly eventBus: IEventBus;
|
|
1277
|
+
```
|
|
1278
|
+
|
|
1279
|
+
- *Type:* aws-cdk-lib.aws_events.IEventBus
|
|
1280
|
+
- *Default:* The default event bus.
|
|
1281
|
+
|
|
1282
|
+
The event bus to associate with this rule.
|
|
1283
|
+
|
|
1284
|
+
---
|
|
1285
|
+
|
|
1286
|
+
##### `schedule`<sup>Optional</sup> <a name="schedule" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.schedule"></a>
|
|
1287
|
+
|
|
1288
|
+
```typescript
|
|
1289
|
+
public readonly schedule: Schedule;
|
|
1290
|
+
```
|
|
1291
|
+
|
|
1292
|
+
- *Type:* aws-cdk-lib.aws_events.Schedule
|
|
1293
|
+
- *Default:* None.
|
|
1294
|
+
|
|
1295
|
+
The schedule or rate (frequency) that determines when EventBridge runs the rule.
|
|
1296
|
+
|
|
1297
|
+
You must specify this property, the `eventPattern` property, or both.
|
|
1298
|
+
|
|
1299
|
+
For more information, see Schedule Expression Syntax for
|
|
1300
|
+
Rules in the Amazon EventBridge User Guide.
|
|
1301
|
+
|
|
1302
|
+
> [https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html)
|
|
1303
|
+
|
|
1304
|
+
---
|
|
1305
|
+
|
|
1306
|
+
##### `targets`<sup>Optional</sup> <a name="targets" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.targets"></a>
|
|
1307
|
+
|
|
1308
|
+
```typescript
|
|
1309
|
+
public readonly targets: IRuleTarget[];
|
|
1310
|
+
```
|
|
1311
|
+
|
|
1312
|
+
- *Type:* aws-cdk-lib.aws_events.IRuleTarget[]
|
|
1313
|
+
- *Default:* No targets.
|
|
1314
|
+
|
|
1315
|
+
Targets to invoke when this rule matches an event.
|
|
1316
|
+
|
|
1317
|
+
Input will be the full matched event. If you wish to specify custom
|
|
1318
|
+
target input, use `addTarget(target[, inputOptions])`.
|
|
1319
|
+
|
|
1320
|
+
---
|
|
1321
|
+
|
|
1322
|
+
##### `targetStates`<sup>Optional</sup> <a name="targetStates" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionStateChangeDetectionEventRuleProps.property.targetStates"></a>
|
|
1323
|
+
|
|
1324
|
+
```typescript
|
|
1325
|
+
public readonly targetStates: CodePipelinePipelineExecutionState[];
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
- *Type:* <a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState">CodePipelinePipelineExecutionState</a>[]
|
|
1329
|
+
|
|
1330
|
+
---
|
|
1331
|
+
|
|
819
1332
|
### CodePipelineStageExecutionStateChangeDetectionEventRuleProps <a name="CodePipelineStageExecutionStateChangeDetectionEventRuleProps" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps"></a>
|
|
820
1333
|
|
|
821
1334
|
#### Initializer <a name="Initializer" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.Initializer"></a>
|
|
@@ -995,42 +1508,115 @@ public readonly targetStates: CodePipelineStageExecutionState[];
|
|
|
995
1508
|
|
|
996
1509
|
---
|
|
997
1510
|
|
|
998
|
-
#####
|
|
1511
|
+
##### ~~`CANCELED`~~ <a name="CANCELED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.CANCELED"></a>
|
|
1512
|
+
|
|
1513
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1514
|
+
|
|
1515
|
+
---
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
##### ~~`FAILED`~~ <a name="FAILED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.FAILED"></a>
|
|
1519
|
+
|
|
1520
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1521
|
+
|
|
1522
|
+
---
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
##### ~~`RESUMED`~~ <a name="RESUMED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.RESUMED"></a>
|
|
1526
|
+
|
|
1527
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1528
|
+
|
|
1529
|
+
---
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
##### ~~`STARTED`~~ <a name="STARTED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.STARTED"></a>
|
|
1533
|
+
|
|
1534
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1535
|
+
|
|
1536
|
+
---
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
##### ~~`STOPPED`~~ <a name="STOPPED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.STOPPED"></a>
|
|
1540
|
+
|
|
1541
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1542
|
+
|
|
1543
|
+
---
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
##### ~~`STOPPING`~~ <a name="STOPPING" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.STOPPING"></a>
|
|
1547
|
+
|
|
1548
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1549
|
+
|
|
1550
|
+
---
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
##### ~~`SUCCEEDED`~~ <a name="SUCCEEDED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.SUCCEEDED"></a>
|
|
1554
|
+
|
|
1555
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1556
|
+
|
|
1557
|
+
---
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
##### ~~`SUPERSEDED`~~ <a name="SUPERSEDED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionState.SUPERSEDED"></a>
|
|
1561
|
+
|
|
1562
|
+
- *Deprecated:* This enum is deprecated. Use the CodePipelinePipelineExecutionState enum instead.
|
|
1563
|
+
|
|
1564
|
+
---
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
### CodePipelinePipelineExecutionState <a name="CodePipelinePipelineExecutionState" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState"></a>
|
|
1568
|
+
|
|
1569
|
+
#### Members <a name="Members" id="Members"></a>
|
|
1570
|
+
|
|
1571
|
+
| **Name** | **Description** |
|
|
1572
|
+
| --- | --- |
|
|
1573
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.CANCELED">CANCELED</a></code> | *No description.* |
|
|
1574
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.FAILED">FAILED</a></code> | *No description.* |
|
|
1575
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.RESUMED">RESUMED</a></code> | *No description.* |
|
|
1576
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.STARTED">STARTED</a></code> | *No description.* |
|
|
1577
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.STOPPED">STOPPED</a></code> | *No description.* |
|
|
1578
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.STOPPING">STOPPING</a></code> | *No description.* |
|
|
1579
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.SUCCEEDED">SUCCEEDED</a></code> | *No description.* |
|
|
1580
|
+
| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.SUPERSEDED">SUPERSEDED</a></code> | *No description.* |
|
|
1581
|
+
|
|
1582
|
+
---
|
|
1583
|
+
|
|
1584
|
+
##### `CANCELED` <a name="CANCELED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.CANCELED"></a>
|
|
999
1585
|
|
|
1000
1586
|
---
|
|
1001
1587
|
|
|
1002
1588
|
|
|
1003
|
-
##### `FAILED` <a name="FAILED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.
|
|
1589
|
+
##### `FAILED` <a name="FAILED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.FAILED"></a>
|
|
1004
1590
|
|
|
1005
1591
|
---
|
|
1006
1592
|
|
|
1007
1593
|
|
|
1008
|
-
##### `RESUMED` <a name="RESUMED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.
|
|
1594
|
+
##### `RESUMED` <a name="RESUMED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.RESUMED"></a>
|
|
1009
1595
|
|
|
1010
1596
|
---
|
|
1011
1597
|
|
|
1012
1598
|
|
|
1013
|
-
##### `STARTED` <a name="STARTED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.
|
|
1599
|
+
##### `STARTED` <a name="STARTED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.STARTED"></a>
|
|
1014
1600
|
|
|
1015
1601
|
---
|
|
1016
1602
|
|
|
1017
1603
|
|
|
1018
|
-
##### `STOPPED` <a name="STOPPED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.
|
|
1604
|
+
##### `STOPPED` <a name="STOPPED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.STOPPED"></a>
|
|
1019
1605
|
|
|
1020
1606
|
---
|
|
1021
1607
|
|
|
1022
1608
|
|
|
1023
|
-
##### `STOPPING` <a name="STOPPING" id="@gammarers/aws-codesuite-state-change-detection-event-rules.
|
|
1609
|
+
##### `STOPPING` <a name="STOPPING" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.STOPPING"></a>
|
|
1024
1610
|
|
|
1025
1611
|
---
|
|
1026
1612
|
|
|
1027
1613
|
|
|
1028
|
-
##### `SUCCEEDED` <a name="SUCCEEDED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.
|
|
1614
|
+
##### `SUCCEEDED` <a name="SUCCEEDED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.SUCCEEDED"></a>
|
|
1029
1615
|
|
|
1030
1616
|
---
|
|
1031
1617
|
|
|
1032
1618
|
|
|
1033
|
-
##### `SUPERSEDED` <a name="SUPERSEDED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.
|
|
1619
|
+
##### `SUPERSEDED` <a name="SUPERSEDED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelinePipelineExecutionState.SUPERSEDED"></a>
|
|
1034
1620
|
|
|
1035
1621
|
---
|
|
1036
1622
|
|