Skip to content

One Observability Workshop v3.0.0


One Observability Workshop / constructs/canary / WorkshopCanary

Abstract Class: WorkshopCanary

Defined in: constructs/canary.ts:55

Abstract base class for CloudWatch Synthetics canaries with IAM role creation and schedule configuration.

Extends

  • Construct

Extended by

Constructors

Constructor

new WorkshopCanary(scope, id, properties): WorkshopCanary

Defined in: constructs/canary.ts:57

Parameters

scope

Construct

id

string

properties

WorkshopCanaryProperties

Returns

WorkshopCanary

Overrides

Construct.constructor

Properties

canary

canary: Canary

Defined in: constructs/canary.ts:56

Methods

getDefaultSSMPolicy()

static getDefaultSSMPolicy(scope, prefix?): PolicyStatement

Defined in: constructs/canary.ts:141

Parameters

scope

Construct

prefix?

string

Returns

PolicyStatement


createOutputs()

abstract createOutputs(properties): void

Defined in: constructs/canary.ts:200

Creates CloudFormation outputs for the Lambda function. Must be implemented by concrete subclasses.

Parameters

properties

WorkshopCanaryProperties

Function configuration properties

Returns

void


getEnvironmentVariables()

abstract getEnvironmentVariables(properties): {[key: string]: string; } | undefined

Defined in: constructs/canary.ts:209

Returns environment variables for the Lambda function. Must be implemented by concrete subclasses.

Parameters

properties

WorkshopCanaryProperties

Function configuration properties

Returns

{[key: string]: string; } | undefined

Map of environment variable names to values