Header menu logo FsCDK

CloudWatchCanaryConfig Type

High-level CloudWatch Synthetics Canary builder following AWS best practices. **Default Settings:** - Runtime = Synthetics Python 3.10 - Schedule = Every 5 minutes - Timeout = 60 seconds - Memory = 960 MB - Active tracing = enabled (X-Ray) **Rationale:** These defaults follow AWS Well-Architected Framework: - Python runtime provides flexibility and ease of use - 5-minute checks balance cost and availability monitoring - Active tracing helps debug canary failures - Memory sized for typical HTTP/HTTPS checks **Use Cases:** - Website uptime monitoring - API endpoint health checks - User workflow validation - Multi-step transactions **Escape Hatch:** Access the underlying CDK Canary via the `Canary` property for advanced scenarios not covered by this builder.

Record fields

Record Field Description

ArtifactsBucketLocation

Full Usage: ArtifactsBucketLocation

Field type: ArtifactsBucketLocation option
Field type: ArtifactsBucketLocation option

CanaryName

Full Usage: CanaryName

Field type: string
Field type: string

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

EnvironmentVariables

Full Usage: EnvironmentVariables

Field type: Map<string, string> option
Field type: Map<string, string> option

FailureRetentionPeriod

Full Usage: FailureRetentionPeriod

Field type: Duration option
Field type: Duration option

Role

Full Usage: Role

Field type: IRole option
Field type: IRole option

Runtime

Full Usage: Runtime

Field type: Runtime option
Field type: Runtime option

Schedule

Full Usage: Schedule

Field type: Schedule option
Field type: Schedule option

StartAfterCreation

Full Usage: StartAfterCreation

Field type: bool option
Field type: bool option

SuccessRetentionPeriod

Full Usage: SuccessRetentionPeriod

Field type: Duration option
Field type: Duration option

Test

Full Usage: Test

Field type: Test option
Field type: Test option

TimeToLive

Full Usage: TimeToLive

Field type: Duration option
Field type: Duration option

Type something to start searching.