Skip to main content

@swamp/aws/synthetics

v2026.04.03.2

AWS SYNTHETICS infrastructure models

Labels

awssyntheticscloudinfrastructure

Contents

Install

$ swamp extension pull @swamp/aws/synthetics

Release Notes

  • Updated: canary, group

@swamp/aws/synthetics/canaryv2026.04.03.2canary.ts

Global Arguments

ArgumentTypeDescription
NamestringName of the canary.
CodeobjectProvide the canary script source
ArtifactS3LocationstringProvide the s3 bucket output location for test results
ArtifactConfig?objectProvide artifact configuration
ScheduleobjectFrequency to run your canaries
ExecutionRoleArnstringLambda Execution role used to run your canaries
RuntimeVersionstringRuntime version of Synthetics Library
SuccessRetentionPeriod?numberRetention period of successful canary runs represented in number of days
FailureRetentionPeriod?numberRetention period of failed canary runs represented in number of days
Tags?array
VPCConfig?objectProvide VPC Configuration if enabled.
RunConfig?objectProvide canary run configuration
StartCanaryAfterCreation?booleanRuns canary if set to True. Default is False
VisualReference?objectVisual reference configuration for visual testing
DeleteLambdaResourcesOnCanaryDeletion?booleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
ResourcesToReplicateTags?arrayList of resources which canary tags should be replicated to.
ProvisionedResourceCleanup?enumSetting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
DryRunAndUpdate?booleanSetting to control if UpdateCanary will perform a DryRun and validate it is PASSING before performing the Update. Default is FALSE.
BrowserConfigs?arrayList of browser configurations for the canary
VisualReferences?arrayList of visual references for the canary
createCreate a Synthetics Canary
getGet a Synthetics Canary
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Canary
updateUpdate a Synthetics Canary
deleteDelete a Synthetics Canary
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Canary
syncSync Synthetics Canary state from AWS

Resources

state(infinite)— Synthetics Canary resource state
@swamp/aws/synthetics/groupv2026.04.03.2group.ts

Global Arguments

ArgumentTypeDescription
NamestringName of the group.
Tags?array
ResourceArns?array
createCreate a Synthetics Group
getGet a Synthetics Group
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Group
updateUpdate a Synthetics Group
deleteDelete a Synthetics Group
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Group
syncSync Synthetics Group state from AWS

Resources

state(infinite)— Synthetics Group resource state