Skip to main content
← back to extensions

Aws/synthetics

@swamp/aws/syntheticsv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS
01README

AWS SYNTHETICS infrastructure models

02Release Notes
  • Updated: canary
03Behaviors2
@swamp/aws/synthetics/canaryv2026.10.25.1canary.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
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.
KmsKeyArn?stringKMS key ARN for encrypting the canary's Lambda function environment variables at rest. If omitted, Lambda uses an AWS-managed key.
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
Replicas?arrayList of replica locations for multi-location canary execution
fn create()
Create a Synthetics Canary
fn get(identifier: string)
Get a Synthetics Canary
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Canary
fn update()
Update a Synthetics Canary
fn delete(identifier: string)
Delete a Synthetics Canary
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Canary
fn sync()
Sync Synthetics Canary state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Synthetics Canary resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

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

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
NamestringName of the group.
Tags?array
ResourceArns?array
fn create()
Create a Synthetics Group
fn get(identifier: string)
Get a Synthetics Group
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Group
fn update()
Update a Synthetics Group
fn delete(identifier: string)
Delete a Synthetics Group
ArgumentTypeDescription
identifierstringThe primary identifier of the Synthetics Group
fn sync()
Sync Synthetics Group state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Synthetics Group resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Synthetics Group resource state
04Previous Versions19
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
  • Updated: canary, group
2026.10.13.1
  • Updated: canary, group
2026.10.08.1
2026.10.06.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.21.1
2026.09.20.1
2026.09.19.1
05Stats
A
100 / 100
Downloads
193
Archive size
420.4 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#aws#synthetics#cloud#infrastructure