API.md

API Reference

Constructs

StepFunctionOrchestrator

Run and Evaluate AWS Cloudwatch Canaries parallel with AWS Step Functions.

State machine's execution will fail if any of the canaries fail but it will wait for all to run before failing.

Initializers

import { StepFunctionOrchestrator } from 'synthetics-canaries-e2e-tests-runner'

new StepFunctionOrchestrator(scope: Construct, id: string, props: StepFunctionOrchestratorProps)

scope^Required

• Type: @aws-cdk/core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: synthetics-canaries-e2e-tests-runner.StepFunctionOrchestratorProps

---

Properties

stateMachine^Required

public readonly stateMachine: StateMachine;

• Type: @aws-cdk/aws-stepfunctions.StateMachine

---

Structs

E2ETestsStepProps

Construction properties for a E2ETestsStep.

Initializer

import { E2ETestsStepProps } from 'synthetics-canaries-e2e-tests-runner'

const e2ETestsStepProps: E2ETestsStepProps = { ... }

canaries^Required

public readonly canaries: Canary[];

• Type: @aws-cdk/aws-synthetics.Canary[]

Array of AWS Cloudwatch canary to execute in this step.

---

inputsFromDeployedStack^Required

public readonly inputsFromDeployedStack: CfnOutput[];

• Type: @aws-cdk/core.CfnOutput[]

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.

Those will be pushed to AWS SSM Parameter store to be accessed by the canary at runtime using the name set as output ExportName.

---

scope^Required

public readonly scope: Construct;

• Type: @aws-cdk/core.Construct

Scope in wich to instantiate the state machine (usually your pipeline stack).

---

StepFunctionOrchestratorProps

Construction properties for a StepFunctionOrchestrator.

Initializer

import { StepFunctionOrchestratorProps } from 'synthetics-canaries-e2e-tests-runner'

const stepFunctionOrchestratorProps: StepFunctionOrchestratorProps = { ... }

canaries^Required

public readonly canaries: Canary[];

• Type: @aws-cdk/aws-synthetics.Canary[]

Array of AWS Cloudwatch canary to execute.

---

Classes

E2ETestsStep

• Implements: @aws-cdk/pipelines.ICodePipelineActionFactory

Run AWS Cloudwatch Canaries end to end tests in parallel in the pipeline.

Initializers

import { E2ETestsStep } from 'synthetics-canaries-e2e-tests-runner'

new E2ETestsStep(id: string, props: E2ETestsStepProps)

id^Required

• Type: string

---

props^Required

• Type: synthetics-canaries-e2e-tests-runner.E2ETestsStepProps

---

Methods

produceAction

public produceAction(stage: IStage, options: ProduceActionOptions)

stage^Required

• Type: @aws-cdk/aws-codepipeline.IStage

---

options^Required

• Type: @aws-cdk/pipelines.ProduceActionOptions

---

Properties

inputsFromDeployedStack^Required

public readonly inputsFromDeployedStack: any[];

• Type: any[]

---

stateMachine^Required

public readonly stateMachine: StateMachine;

• Type: @aws-cdk/aws-stepfunctions.StateMachine

---