Aws/synthetics
@swamp/aws/syntheticsv2026.09.11.1
01README
AWS SYNTHETICS infrastructure models
02Models
@swamp/aws/synthetics/canaryv2026.08.17.2canary.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | Name of the canary. |
| Code | object | Provide the canary script source |
| ArtifactS3Location | string | Provide the s3 bucket output location for test results |
| ArtifactConfig? | object | Provide artifact configuration |
| Schedule | object | Frequency to run your canaries |
| ExecutionRoleArn | string | Lambda Execution role used to run your canaries |
| RuntimeVersion | string | Runtime version of Synthetics Library |
| SuccessRetentionPeriod? | number | Retention period of successful canary runs represented in number of days |
| FailureRetentionPeriod? | number | Retention period of failed canary runs represented in number of days |
| Tags? | array | |
| VPCConfig? | object | Provide VPC Configuration if enabled. |
| RunConfig? | object | Provide canary run configuration |
| StartCanaryAfterCreation? | boolean | Runs canary if set to True. Default is False |
| VisualReference? | object | Visual reference configuration for visual testing |
| DeleteLambdaResourcesOnCanaryDeletion? | boolean | Deletes associated lambda resources created by Synthetics if set to True. Default is False |
| ResourcesToReplicateTags? | array | List of resources which canary tags should be replicated to. |
| ProvisionedResourceCleanup? | enum | Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC. |
| KmsKeyArn? | string | KMS key ARN for encrypting the canary's Lambda function environment variables at rest. If omitted, Lambda uses an AWS-managed key. |
| DryRunAndUpdate? | boolean | Setting to control if UpdateCanary will perform a DryRun and validate it is PASSING before performing the Update. Default is FALSE. |
| BrowserConfigs? | array | List of browser configurations for the canary |
| VisualReferences? | array | List of visual references for the canary |
| Replicas? | array | List of replica locations for multi-location canary execution |
fn create()
Create a Synthetics Canary
fn get(identifier: string)
Get a Synthetics Canary
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Synthetics Canary |
fn update()
Update a Synthetics Canary
fn delete(identifier: string)
Delete a Synthetics Canary
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Synthetics Canary |
fn sync()
Sync Synthetics Canary state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Synthetics Canary resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Synthetics Canary resource state
@swamp/aws/synthetics/groupv2026.08.17.2group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | Name of the group. |
| Tags? | array | |
| ResourceArns? | array |
fn create()
Create a Synthetics Group
fn get(identifier: string)
Get a Synthetics Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Synthetics Group |
fn update()
Update a Synthetics Group
fn delete(identifier: string)
Delete a Synthetics Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Synthetics Group |
fn sync()
Sync Synthetics Group state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Synthetics Group resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Synthetics Group resource state
03Previous Versions
2026.09.10.1
2026.09.09.1
2026.09.08.1
2026.09.07.1
2026.09.06.3
2026.09.06.1
2026.09.05.1
2026.09.04.1
2026.09.03.1
2026.09.02.1
2026.09.01.1
2026.08.31.1
2026.08.30.1
2026.08.29.1
2026.08.28.1
2026.08.27.1
2026.08.26.1
2026.08.25.6
2026.08.25.5
04Stats
A
100 / 100
Downloads
0
Archive size
504.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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels