@gammarers/aws-codesuite-state-change-detection-event-rules 2.1.21 → 2.2.0

package/API.md

@@ -315,6 +315,319 @@ The name event rule.
 ---
 
 
+### CodePipelineStageExecutionStateChangeDetectionEventRule <a name="CodePipelineStageExecutionStateChangeDetectionEventRule" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule"></a>
+
+#### Initializers <a name="Initializers" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.Initializer"></a>
+
+```typescript
+import { CodePipelineStageExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
+
+new CodePipelineStageExecutionStateChangeDetectionEventRule(scope: Construct, id: string, props: CodePipelineStageExecutionStateChangeDetectionEventRuleProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.Initializer.parameter.props">props</a></code> | <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps">CodePipelineStageExecutionStateChangeDetectionEventRuleProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps">CodePipelineStageExecutionStateChangeDetectionEventRuleProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.addEventPattern">addEventPattern</a></code> | Adds an event pattern filter to this rule. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.addTarget">addTarget</a></code> | Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets. |
+
+---
+
+##### `toString` <a name="toString" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.applyRemovalPolicy"></a>
+
+```typescript
+public applyRemovalPolicy(policy: RemovalPolicy): void
+```
+
+Apply the given removal policy to this resource.
+
+The Removal Policy controls what happens to this resource when it stops
+being managed by CloudFormation, either because you've removed it from the
+CDK application or because you've made a change that requires the resource
+to be replaced.
+
+The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
+account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
+
+###### `policy`<sup>Required</sup> <a name="policy" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.applyRemovalPolicy.parameter.policy"></a>
+
+- *Type:* aws-cdk-lib.RemovalPolicy
+
+---
+
+##### `addEventPattern` <a name="addEventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.addEventPattern"></a>
+
+```typescript
+public addEventPattern(eventPattern?: EventPattern): void
+```
+
+Adds an event pattern filter to this rule.
+
+If a pattern was already specified,
+these values are merged into the existing pattern.
+
+For example, if the rule already contains the pattern:
+
+   {
+     "resources": [ "r1" ],
+     "detail": {
+       "hello": [ 1 ]
+     }
+   }
+
+And `addEventPattern` is called with the pattern:
+
+   {
+     "resources": [ "r2" ],
+     "detail": {
+       "foo": [ "bar" ]
+     }
+   }
+
+The resulting event pattern will be:
+
+   {
+     "resources": [ "r1", "r2" ],
+     "detail": {
+       "hello": [ 1 ],
+       "foo": [ "bar" ]
+     }
+   }
+
+###### `eventPattern`<sup>Optional</sup> <a name="eventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.addEventPattern.parameter.eventPattern"></a>
+
+- *Type:* aws-cdk-lib.aws_events.EventPattern
+
+---
+
+##### `addTarget` <a name="addTarget" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.addTarget"></a>
+
+```typescript
+public addTarget(target?: IRuleTarget): void
+```
+
+Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.
+
+No-op if target is undefined.
+
+###### `target`<sup>Optional</sup> <a name="target" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.addTarget.parameter.target"></a>
+
+- *Type:* aws-cdk-lib.aws_events.IRuleTarget
+
+---
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.fromEventRuleArn">fromEventRuleArn</a></code> | Import an existing EventBridge Rule provided an ARN. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isConstruct"></a>
+
+```typescript
+import { CodePipelineStageExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
+
+CodePipelineStageExecutionStateChangeDetectionEventRule.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+##### `isOwnedResource` <a name="isOwnedResource" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isOwnedResource"></a>
+
+```typescript
+import { CodePipelineStageExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
+
+CodePipelineStageExecutionStateChangeDetectionEventRule.isOwnedResource(construct: IConstruct)
+```
+
+Returns true if the construct was created by CDK, and false otherwise.
+
+###### `construct`<sup>Required</sup> <a name="construct" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isOwnedResource.parameter.construct"></a>
+
+- *Type:* constructs.IConstruct
+
+---
+
+##### `isResource` <a name="isResource" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isResource"></a>
+
+```typescript
+import { CodePipelineStageExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
+
+CodePipelineStageExecutionStateChangeDetectionEventRule.isResource(construct: IConstruct)
+```
+
+Check whether the given construct is a Resource.
+
+###### `construct`<sup>Required</sup> <a name="construct" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.isResource.parameter.construct"></a>
+
+- *Type:* constructs.IConstruct
+
+---
+
+##### `fromEventRuleArn` <a name="fromEventRuleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.fromEventRuleArn"></a>
+
+```typescript
+import { CodePipelineStageExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
+
+CodePipelineStageExecutionStateChangeDetectionEventRule.fromEventRuleArn(scope: Construct, id: string, eventRuleArn: string)
+```
+
+Import an existing EventBridge Rule provided an ARN.
+
+###### `scope`<sup>Required</sup> <a name="scope" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.fromEventRuleArn.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+The parent creating construct (usually `this`).
+
+---
+
+###### `id`<sup>Required</sup> <a name="id" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.fromEventRuleArn.parameter.id"></a>
+
+- *Type:* string
+
+The construct's name.
+
+---
+
+###### `eventRuleArn`<sup>Required</sup> <a name="eventRuleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.fromEventRuleArn.parameter.eventRuleArn"></a>
+
+- *Type:* string
+
+Event Rule ARN (i.e. arn:aws:events:<region>:<account-id>:rule/MyScheduledRule).
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.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. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.ruleName">ruleName</a></code> | <code>string</code> | The name event rule. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `env`<sup>Required</sup> <a name="env" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.env"></a>
+
+```typescript
+public readonly env: ResourceEnvironment;
+```
+
+- *Type:* aws-cdk-lib.ResourceEnvironment
+
+The environment this resource belongs to.
+
+For resources that are created and managed by the CDK
+(generally, those created by creating new class instances like Role, Bucket, etc.),
+this is always the same as the environment of the stack they belong to;
+however, for imported resources
+(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
+that might be different than the stack they were imported into.
+
+---
+
+##### `stack`<sup>Required</sup> <a name="stack" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.stack"></a>
+
+```typescript
+public readonly stack: Stack;
+```
+
+- *Type:* aws-cdk-lib.Stack
+
+The stack in which this resource is defined.
+
+---
+
+##### `ruleArn`<sup>Required</sup> <a name="ruleArn" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.ruleArn"></a>
+
+```typescript
+public readonly ruleArn: string;
+```
+
+- *Type:* string
+
+The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
+
+---
+
+##### `ruleName`<sup>Required</sup> <a name="ruleName" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRule.property.ruleName"></a>
+
+```typescript
+public readonly ruleName: string;
+```
+
+- *Type:* string
+
+The name event rule.
+
+---
+
+
 ## Structs <a name="Structs" id="Structs"></a>
 
 ### CodePipelineExecutionStateChangeDetectionEventRuleProps <a name="CodePipelineExecutionStateChangeDetectionEventRuleProps" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRuleProps"></a>
@@ -475,6 +788,164 @@ public readonly targetStates: CodePipelineExecutionState[];
 
 ---
 
+### CodePipelineStageExecutionStateChangeDetectionEventRuleProps <a name="CodePipelineStageExecutionStateChangeDetectionEventRuleProps" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps"></a>
+
+#### Initializer <a name="Initializer" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.Initializer"></a>
+
+```typescript
+import { CodePipelineStageExecutionStateChangeDetectionEventRuleProps } from '@gammarers/aws-codesuite-state-change-detection-event-rules'
+
+const codePipelineStageExecutionStateChangeDetectionEventRuleProps: CodePipelineStageExecutionStateChangeDetectionEventRuleProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.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). |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.description">description</a></code> | <code>string</code> | A description of the rule's purpose. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.eventPattern">eventPattern</a></code> | <code>aws-cdk-lib.aws_events.EventPattern</code> | Additional restrictions for the event to route to the specified target. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.ruleName">ruleName</a></code> | <code>string</code> | A name for the rule. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.enabled">enabled</a></code> | <code>boolean</code> | Indicates whether the rule is enabled. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.eventBus">eventBus</a></code> | <code>aws-cdk-lib.aws_events.IEventBus</code> | The event bus to associate with this rule. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.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. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.targets">targets</a></code> | <code>aws-cdk-lib.aws_events.IRuleTarget[]</code> | Targets to invoke when this rule matches an event. |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.targetStates">targetStates</a></code> | <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState">CodePipelineStageExecutionState</a>[]</code> | *No description.* |
+
+---
+
+##### `crossStackScope`<sup>Optional</sup> <a name="crossStackScope" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.crossStackScope"></a>
+
+```typescript
+public readonly crossStackScope: Construct;
+```
+
+- *Type:* constructs.Construct
+- *Default:* none (the main scope will be used, even for cross-stack Events)
+
+The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
+
+This helps dealing with cycles that often arise in these situations.
+
+---
+
+##### `description`<sup>Optional</sup> <a name="description" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.description"></a>
+
+```typescript
+public readonly description: string;
+```
+
+- *Type:* string
+- *Default:* No description
+
+A description of the rule's purpose.
+
+---
+
+##### `eventPattern`<sup>Optional</sup> <a name="eventPattern" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.eventPattern"></a>
+
+```typescript
+public readonly eventPattern: EventPattern;
+```
+
+- *Type:* aws-cdk-lib.aws_events.EventPattern
+- *Default:* No additional filtering based on an event pattern.
+
+Additional restrictions for the event to route to the specified target.
+
+The method that generates the rule probably imposes some type of event
+filtering. The filtering implied by what you pass here is added
+on top of that filtering.
+
+> [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)
+
+---
+
+##### `ruleName`<sup>Optional</sup> <a name="ruleName" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.ruleName"></a>
+
+```typescript
+public readonly ruleName: string;
+```
+
+- *Type:* string
+- *Default:* AWS CloudFormation generates a unique physical ID.
+
+A name for the rule.
+
+---
+
+##### `enabled`<sup>Optional</sup> <a name="enabled" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.enabled"></a>
+
+```typescript
+public readonly enabled: boolean;
+```
+
+- *Type:* boolean
+- *Default:* true
+
+Indicates whether the rule is enabled.
+
+---
+
+##### `eventBus`<sup>Optional</sup> <a name="eventBus" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.eventBus"></a>
+
+```typescript
+public readonly eventBus: IEventBus;
+```
+
+- *Type:* aws-cdk-lib.aws_events.IEventBus
+- *Default:* The default event bus.
+
+The event bus to associate with this rule.
+
+---
+
+##### `schedule`<sup>Optional</sup> <a name="schedule" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.schedule"></a>
+
+```typescript
+public readonly schedule: Schedule;
+```
+
+- *Type:* aws-cdk-lib.aws_events.Schedule
+- *Default:* None.
+
+The schedule or rate (frequency) that determines when EventBridge runs the rule.
+
+You must specify this property, the `eventPattern` property, or both.
+
+For more information, see Schedule Expression Syntax for
+Rules in the Amazon EventBridge User Guide.
+
+> [https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html)
+
+---
+
+##### `targets`<sup>Optional</sup> <a name="targets" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.targets"></a>
+
+```typescript
+public readonly targets: IRuleTarget[];
+```
+
+- *Type:* aws-cdk-lib.aws_events.IRuleTarget[]
+- *Default:* No targets.
+
+Targets to invoke when this rule matches an event.
+
+Input will be the full matched event. If you wish to specify custom
+target input, use `addTarget(target[, inputOptions])`.
+
+---
+
+##### `targetStates`<sup>Optional</sup> <a name="targetStates" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionStateChangeDetectionEventRuleProps.property.targetStates"></a>
+
+```typescript
+public readonly targetStates: CodePipelineStageExecutionState[];
+```
+
+- *Type:* <a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState">CodePipelineStageExecutionState</a>[]
+
+---
+
 
 
 ## Enums <a name="Enums" id="Enums"></a>
@@ -535,3 +1006,54 @@ public readonly targetStates: CodePipelineExecutionState[];
 
 ---
 
+
+### CodePipelineStageExecutionState <a name="CodePipelineStageExecutionState" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState"></a>
+
+#### Members <a name="Members" id="Members"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.CANCELED">CANCELED</a></code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.FAILED">FAILED</a></code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.RESUMED">RESUMED</a></code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.STARTED">STARTED</a></code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.STOPPED">STOPPED</a></code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.STOPPING">STOPPING</a></code> | *No description.* |
+| <code><a href="#@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.SUCCEEDED">SUCCEEDED</a></code> | *No description.* |
+
+---
+
+##### `CANCELED` <a name="CANCELED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.CANCELED"></a>
+
+---
+
+
+##### `FAILED` <a name="FAILED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.FAILED"></a>
+
+---
+
+
+##### `RESUMED` <a name="RESUMED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.RESUMED"></a>
+
+---
+
+
+##### `STARTED` <a name="STARTED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.STARTED"></a>
+
+---
+
+
+##### `STOPPED` <a name="STOPPED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.STOPPED"></a>
+
+---
+
+
+##### `STOPPING` <a name="STOPPING" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.STOPPING"></a>
+
+---
+
+
+##### `SUCCEEDED` <a name="SUCCEEDED" id="@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineStageExecutionState.SUCCEEDED"></a>
+
+---
+

package/README.md

@@ -36,6 +36,8 @@ bun add @gammarers/aws-codesuite-state-change-detection-event-rules
 
 ## Example
 
+### CodePipeline Pipeline Execution State Change Detection Event Rule Handling
+
 ```typescript
 import { CodePipelineExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules';
 
@@ -52,6 +54,24 @@ const rule = new CodePipelineExecutionStateChangeDetectionEventRule(stack, 'Code
 
 ```
 
+### CodePipeline Stage Execution State Chagen Detection Event Rule Handling
+
+```ts
+import { CodePipelineStageExecutionStateChangeDetectionEventRule } from '@gammarers/aws-codesuite-state-change-detection-event-rules';
+
+const fn = new lambda.Function(this, 'MyFunc', {
+  runtime: lambda.Runtime.NODEJS_LATEST,
+  handler: 'index.handler',
+  code: lambda.Code.fromInline(`exports.handler = handler.toString()`),
+});
+
+const rule = new CodePipelineStageExecutionStateChangeDetectionEventRule(stack, 'CodePipelineStageExecutionStateChangeDetectionEventRule', {
+  targets: new targets.LambdaFunction(fn),
+});
+
+```
+
+
 ## License
 
 This project is licensed under the Apache-2.0 License.

package/lib/codepipeline-execution-state-change-detection-event-rule.js

@@ -51,5 +51,5 @@ class CodePipelineExecutionStateChangeDetectionEventRule extends events.Rule {
 }
 exports.CodePipelineExecutionStateChangeDetectionEventRule = CodePipelineExecutionStateChangeDetectionEventRule;
 _a = JSII_RTTI_SYMBOL_1;
-CodePipelineExecutionStateChangeDetectionEventRule[_a] = { fqn: "@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule", version: "2.1.21" };
+CodePipelineExecutionStateChangeDetectionEventRule[_a] = { fqn: "@gammarers/aws-codesuite-state-change-detection-event-rules.CodePipelineExecutionStateChangeDetectionEventRule", version: "2.2.0" };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29kZXBpcGVsaW5lLWV4ZWN1dGlvbi1zdGF0ZS1jaGFuZ2UtZGV0ZWN0aW9uLWV2ZW50LXJ1bGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY29kZXBpcGVsaW5lLWV4ZWN1dGlvbi1zdGF0ZS1jaGFuZ2UtZGV0ZWN0aW9uLWV2ZW50LXJ1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw4REFBb0Y7QUFDcEYsaURBQWlEO0FBR2pEOzs7OztHQUtHO0FBRUgsSUFBWSwwQkFTWDtBQVRELFdBQVksMEJBQTBCO0lBQ3BDLG1EQUFxQixDQUFBO0lBQ3JCLCtDQUFpQixDQUFBO0lBQ2pCLGlEQUFtQixDQUFBO0lBQ25CLGlEQUFtQixDQUFBO0lBQ25CLGlEQUFtQixDQUFBO0lBQ25CLG1EQUFxQixDQUFBO0lBQ3JCLHFEQUF1QixDQUFBO0lBQ3ZCLHVEQUF5QixDQUFBO0FBQzNCLENBQUMsRUFUVywwQkFBMEIsMENBQTFCLDBCQUEwQixRQVNyQztBQU1ELE1BQWEsa0RBQW1ELFNBQVEsTUFBTSxDQUFDLElBQUk7SUFDakYsWUFBWSxLQUFnQixFQUFFLEVBQVUsRUFBRSxLQUE4RDtRQUN0RyxLQUFLLENBQUMsS0FBSyxFQUFFLEVBQUUsRUFBRTtZQUNmLEdBQUcsS0FBSztZQUNSLFlBQVksRUFBRSxDQUFDLEdBQXdCLEVBQUU7Z0JBQ3ZDLElBQUksS0FBSyxDQUFDLFlBQVksRUFBRSxDQUFDO29CQUN2QixNQUFNLElBQUksd0RBQXVDLENBQUMsY0FBYyxDQUFDLENBQUM7Z0JBQ3BFLENBQUM7Z0JBQ0QsT0FBTztvQkFDTCxNQUFNLEVBQUUsQ0FBQyxrQkFBa0IsQ0FBQztvQkFDNUIsVUFBVSxFQUFFLENBQUMsOENBQThDLENBQUM7b0JBQzVELHFCQUFxQjtvQkFDckIsd0NBQXdDO29CQUN4QyxjQUFjO29CQUNkLE1BQU0sRUFBRSxDQUFDLEdBQUcsRUFBRTt3QkFDWixJQUFJLEtBQUssQ0FBQyxZQUFZLEVBQUUsQ0FBQzs0QkFDdkIsT0FBTztnQ0FDTCxLQUFLLEVBQUUsS0FBSyxDQUFDLFlBQVk7NkJBQzFCLENBQUM7d0JBQ0osQ0FBQzt3QkFDRCxPQUFPLFNBQVMsQ0FBQztvQkFDbkIsQ0FBQyxDQUFDLEVBQUU7aUJBQ0wsQ0FBQztZQUNKLENBQUMsQ0FBQyxFQUFFO1NBQ0wsQ0FBQyxDQUFDO0lBQ0wsQ0FBQzs7QUF6QkgsZ0hBMEJDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgSW52YWxpZEludGVybmFsRGVmaW5pdGlvblBhcmFtZXRlckVycm9yIH0gZnJvbSAnQGdhbW1hcmVycy9hd3MtY2RrLWVycm9ycyc7XG5pbXBvcnQgKiBhcyBldmVudHMgZnJvbSAnYXdzLWNkay1saWIvYXdzLWV2ZW50cyc7XG5pbXBvcnQgeyBDb25zdHJ1Y3QgfSBmcm9tICdjb25zdHJ1Y3RzJztcblxuLyoqXG4gKiBAVE9ETzogTm90IHlldCBzdXBwb3J0ZWQgT21pdFxuICogaHR0cHM6Ly9naXRodWIuY29tL2F3cy9qc2lpL2lzc3Vlcy80NDY4XG4gKiB0eXBlIG9taXRLZXlzID0gJ2V2ZW50UGF0dGVybic7XG4gKiBleHBvcnQgaW50ZXJmYWNlIENvZGVQaXBlbGluZVN0YXRlQ2hhbmdlRGV0ZWN0aW9uRXZlbnRSdWxlUHJvcHMgZXh0ZW5kcyBPbWl0PGV2ZW50cy5SdWxlUHJvcHMsICdldmVudFBhdHRlcm4nPiB7fVxuICovXG5cbmV4cG9ydCBlbnVtIENvZGVQaXBlbGluZUV4ZWN1dGlvblN0YXRlIHtcbiAgQ0FOQ0VMRUQgPSAnQ0FOQ0VMRUQnLFxuICBGQUlMRUQgPSAnRkFJTEVEJyxcbiAgUkVTVU1FRCA9ICdSRVNVTUVEJyxcbiAgU1RBUlRFRCA9ICdTVEFSVEVEJyxcbiAgU1RPUFBFRCA9ICdTVE9QUEVEJyxcbiAgU1RPUFBJTkcgPSAnU1RPUFBJTkcnLFxuICBTVUNDRUVERUQgPSAnU1VDQ0VFREVEJyxcbiAgU1VQRVJTRURFRCA9ICdTVVBFUlNFREVEJyxcbn1cblxuZXhwb3J0IGludGVyZmFjZSBDb2RlUGlwZWxpbmVFeGVjdXRpb25TdGF0ZUNoYW5nZURldGVjdGlvbkV2ZW50UnVsZVByb3BzIGV4dGVuZHMgZXZlbnRzLlJ1bGVQcm9wcyB7XG4gIHJlYWRvbmx5IHRhcmdldFN0YXRlcz86IENvZGVQaXBlbGluZUV4ZWN1dGlvblN0YXRlW107XG59XG5cbmV4cG9ydCBjbGFzcyBDb2RlUGlwZWxpbmVFeGVjdXRpb25TdGF0ZUNoYW5nZURldGVjdGlvbkV2ZW50UnVsZSBleHRlbmRzIGV2ZW50cy5SdWxlIHtcbiAgY29uc3RydWN0b3Ioc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgcHJvcHM6IENvZGVQaXBlbGluZUV4ZWN1dGlvblN0YXRlQ2hhbmdlRGV0ZWN0aW9uRXZlbnRSdWxlUHJvcHMpIHtcbiAgICBzdXBlcihzY29wZSwgaWQsIHtcbiAgICAgIC4uLnByb3BzLFxuICAgICAgZXZlbnRQYXR0ZXJuOiAoKCk6IGV2ZW50cy5FdmVudFBhdHRlcm4gPT4ge1xuICAgICAgICBpZiAocHJvcHMuZXZlbnRQYXR0ZXJuKSB7XG4gICAgICAgICAgdGhyb3cgbmV3IEludmFsaWRJbnRlcm5hbERlZmluaXRpb25QYXJhbWV0ZXJFcnJvcignZXZlbnRQYXR0ZXJuJyk7XG4gICAgICAgIH1cbiAgICAgICAgcmV0dXJuIHtcbiAgICAgICAgICBzb3VyY2U6IFsnYXdzLmNvZGVwaXBlbGluZSddLFxuICAgICAgICAgIGRldGFpbFR5cGU6IFsnQ29kZVBpcGVsaW5lIFBpcGVsaW5lIEV4ZWN1dGlvbiBTdGF0ZSBDaGFuZ2UnXSxcbiAgICAgICAgICAvLyAgICAgICAgICBkZXRhaWw6IHtcbiAgICAgICAgICAvLyAgICAgICAgICAgIHN0YXRlOiBwcm9wcy50YXJnZXRTdGF0ZXMsXG4gICAgICAgICAgLy8gICAgICAgICAgfSxcbiAgICAgICAgICBkZXRhaWw6ICgoKSA9PiB7XG4gICAgICAgICAgICBpZiAocHJvcHMudGFyZ2V0U3RhdGVzKSB7XG4gICAgICAgICAgICAgIHJldHVybiB7XG4gICAgICAgICAgICAgICAgc3RhdGU6IHByb3BzLnRhcmdldFN0YXRlcyxcbiAgICAgICAgICAgICAgfTtcbiAgICAgICAgICAgIH1cbiAgICAgICAgICAgIHJldHVybiB1bmRlZmluZWQ7XG4gICAgICAgICAgfSkoKSxcbiAgICAgICAgfTtcbiAgICAgIH0pKCksXG4gICAgfSk7XG4gIH1cbn0iXX0=

package/lib/codepipeline-stage-execution-state-change-detection-event-rule.d.ts

@@ -0,0 +1,23 @@
+import * as events from 'aws-cdk-lib/aws-events';
+import { Construct } from 'constructs';
+/**
+ * @TODO: Not yet supported Omit
+ * https://github.com/aws/jsii/issues/4468
+ * type omitKeys = 'eventPattern';
+ * export interface CodePipelineStateChangeDetectionEventRuleProps extends Omit<events.RuleProps, 'eventPattern'> {}
+ */
+export declare enum CodePipelineStageExecutionState {
+    CANCELED = "CANCELED",
+    FAILED = "FAILED",
+    RESUMED = "RESUMED",
+    STARTED = "STARTED",
+    STOPPED = "STOPPED",
+    STOPPING = "STOPPING",
+    SUCCEEDED = "SUCCEEDED"
+}
+export interface CodePipelineStageExecutionStateChangeDetectionEventRuleProps extends events.RuleProps {
+    readonly targetStates?: CodePipelineStageExecutionState[];
+}
+export declare class CodePipelineStageExecutionStateChangeDetectionEventRule extends events.Rule {
+    constructor(scope: Construct, id: string, props: CodePipelineStageExecutionStateChangeDetectionEventRuleProps);
+}