Skip to content

Commit 1677048

Browse files
author
Florian CHAZAL
committed
feat: release 0.0.1
1 parent 322c09a commit 1677048

File tree

4 files changed

+41
-4
lines changed

4 files changed

+41
-4
lines changed

.projen/tasks.json

+9-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

API.md

+28
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,34 @@ new StepFunctionOrchestrator(scope: Construct, id: string, props: StepFunctionOr
4343

4444
## Structs <a name="Structs"></a>
4545

46+
### E2ETestsStepProps <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps"></a>
47+
48+
#### Initializer <a name="[object Object].Initializer"></a>
49+
50+
```typescript
51+
import { E2ETestsStepProps } from 'synthetics-canaries-e2e-tests-runner'
52+
53+
const e2ETestsStepProps: E2ETestsStepProps = { ... }
54+
```
55+
56+
##### `canaries`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.canaries"></a>
57+
58+
- *Type:* [`@aws-cdk/aws-synthetics.Canary`](#@aws-cdk/aws-synthetics.Canary)[]
59+
60+
---
61+
62+
##### `inputsFromDeployedStack`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.inputsFromDeployedStack"></a>
63+
64+
- *Type:* [`@aws-cdk/core.CfnOutput`](#@aws-cdk/core.CfnOutput)[]
65+
66+
---
67+
68+
##### `scope`<sup>Required</sup> <a name="synthetics-canaries-e2e-tests-runner.E2ETestsStepProps.property.scope"></a>
69+
70+
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
71+
72+
---
73+
4674
### StepFunctionOrchestratorProps <a name="synthetics-canaries-e2e-tests-runner.StepFunctionOrchestratorProps"></a>
4775

4876
#### Initializer <a name="[object Object].Initializer"></a>

package.json

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/e2e-test-step.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import { StepFunctionOrchestrator } from './orchestrator';
88

99
export interface E2ETestsStepProps {
1010

11-
canaries: synthetics.Canary[];
12-
scope: cdk.Construct;
13-
inputsFromDeployedStack: cdk.CfnOutput[];
11+
readonly canaries: synthetics.Canary[];
12+
readonly scope: cdk.Construct;
13+
readonly inputsFromDeployedStack: cdk.CfnOutput[];
1414
}
1515

1616
export default class E2ETestsStep extends cdkpipeline.Step implements cdkpipeline.ICodePipelineActionFactory {

0 commit comments

Comments
 (0)