One Observability Workshop v3.0.0

One Observability Workshop / constructs/canary / WorkshopCanaryProperties

Interface: WorkshopCanaryProperties¶

Defined in: constructs/canary.ts:30

Properties for configuring a CloudWatch Synthetics canary.

Properties¶

artifactsBucket?¶

optional artifactsBucket: IBucket

Defined in: constructs/canary.ts:32

S3 bucket for canary artifacts and screenshots

runtime¶

runtime: Runtime

Defined in: constructs/canary.ts:34

Synthetics runtime version

scheduleExpression?¶

optional scheduleExpression: string

Defined in: constructs/canary.ts:36

CloudWatch Events schedule expression (default: rate(5 minutes))

handler¶

handler: string

Defined in: constructs/canary.ts:38

Handler function name within the canary code

path¶

path: string

Defined in: constructs/canary.ts:40

Path to the canary source code directory

logRetentionDays?¶

optional logRetentionDays: RetentionDays

Defined in: constructs/canary.ts:42

CloudWatch Logs retention period

name¶

name: string

Defined in: constructs/canary.ts:44

Canary name used for CloudWatch identification