@@ -8,7 +8,7 @@ Run and Evaluate AWS Cloudwatch Canaries parallel with AWS Step Functions.
8
8
9
9
State machine's execution will fail if any of the canaries fail but it will wait for all to run before failing.
10
10
11
- #### Initializer <a name =" synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.Initializer " ></a >
11
+ #### Initializers <a name =" synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.Initializer " ></a >
12
12
13
13
``` typescript
14
14
import { StepFunctionOrchestrator } from ' synthetics-canaries-e2e-tests-runner'
@@ -40,6 +40,10 @@ new StepFunctionOrchestrator(scope: Construct, id: string, props: StepFunctionOr
40
40
41
41
##### ` stateMachine ` <sup >Required</sup > <a name =" synthetics-canaries-e2e-tests-runner.StepFunctionOrchestrator.property.stateMachine " ></a >
42
42
43
+ ``` typescript
44
+ public readonly stateMachine : StateMachine ;
45
+ ```
46
+
43
47
- * Type:* [ ` @aws-cdk/aws-stepfunctions.StateMachine ` ] ( #@aws-cdk/aws-stepfunctions.StateMachine )
44
48
45
49
---
@@ -61,6 +65,10 @@ const e2ETestsStepProps: E2ETestsStepProps = { ... }
61
65
62
66
##### ` canaries ` <sup >Required</sup > <a name =" synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.canaries " ></a >
63
67
68
+ ``` typescript
69
+ public readonly canaries : Canary [];
70
+ ```
71
+
64
72
- * Type:* [ ` @aws-cdk/aws-synthetics.Canary ` ] ( #@aws-cdk/aws-synthetics.Canary ) [ ]
65
73
66
74
Array of AWS Cloudwatch canary to execute in this step.
@@ -69,6 +77,10 @@ Array of AWS Cloudwatch canary to execute in this step.
69
77
70
78
##### ` inputsFromDeployedStack ` <sup >Required</sup > <a name =" synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.inputsFromDeployedStack " ></a >
71
79
80
+ ``` typescript
81
+ public readonly inputsFromDeployedStack : CfnOutput [];
82
+ ```
83
+
72
84
- * Type:* [ ` @aws-cdk/core.CfnOutput ` ] ( #@aws-cdk/core.CfnOutput ) [ ]
73
85
74
86
The potential list of CloudFormation outputs exposed by the App under test deployed in the previous step of the code pipeline workflow and that are needed by canaries to run properly.
@@ -80,6 +92,10 @@ Those will be pushed to AWS SSM Parameter store to be accessed by the canary at
80
92
81
93
##### ` scope ` <sup >Required</sup > <a name =" synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.scope " ></a >
82
94
95
+ ``` typescript
96
+ public readonly scope : Construct ;
97
+ ```
98
+
83
99
- * Type:* [ ` @aws-cdk/core.Construct ` ] ( #@aws-cdk/core.Construct )
84
100
85
101
Scope in wich to instantiate the state machine (usually your pipeline stack).
@@ -100,6 +116,10 @@ const stepFunctionOrchestratorProps: StepFunctionOrchestratorProps = { ... }
100
116
101
117
##### ` canaries ` <sup >Required</sup > <a name =" synthetics-canaries-e2e-tests-runner.StepFunctionOrchestratorProps.property.canaries " ></a >
102
118
119
+ ``` typescript
120
+ public readonly canaries : Canary [];
121
+ ```
122
+
103
123
- * Type:* [ ` @aws-cdk/aws-synthetics.Canary ` ] ( #@aws-cdk/aws-synthetics.Canary ) [ ]
104
124
105
125
Array of AWS Cloudwatch canary to execute.
@@ -114,7 +134,7 @@ Array of AWS Cloudwatch canary to execute.
114
134
115
135
Run AWS Cloudwatch Canaries end to end tests in parallel in the pipeline.
116
136
117
- #### Initializer <a name =" synthetics-canaries-e2e-tests-runner.E2ETestsStep.Initializer " ></a >
137
+ #### Initializers <a name =" synthetics-canaries-e2e-tests-runner.E2ETestsStep.Initializer " ></a >
118
138
119
139
``` typescript
120
140
import { E2ETestsStep } from ' synthetics-canaries-e2e-tests-runner'
@@ -159,12 +179,20 @@ public produceAction(stage: IStage, options: ProduceActionOptions)
159
179
160
180
##### ` inputsFromDeployedStack ` <sup >Required</sup > <a name =" synthetics-canaries-e2e-tests-runner.E2ETestsStep.property.inputsFromDeployedStack " ></a >
161
181
182
+ ``` typescript
183
+ public readonly inputsFromDeployedStack : any [];
184
+ ```
185
+
162
186
- * Type:* ` any ` [ ]
163
187
164
188
---
165
189
166
190
##### ` stateMachine ` <sup >Required</sup > <a name =" synthetics-canaries-e2e-tests-runner.E2ETestsStep.property.stateMachine " ></a >
167
191
192
+ ``` typescript
193
+ public readonly stateMachine : StateMachine ;
194
+ ```
195
+
168
196
- * Type:* [ ` @aws-cdk/aws-stepfunctions.StateMachine ` ] ( #@aws-cdk/aws-stepfunctions.StateMachine )
169
197
170
198
---
0 commit comments