Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-synthetics-canary.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Synthetics::Canary. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-synthetics

Properties

Name string | Aws_CF_FunctionString required

Name of the canary.

Code object required
One of: variant, variant
6 nested properties
Handler string | Aws_CF_FunctionString required
S3Bucket string | Aws_CF_FunctionString
S3Key string | Aws_CF_FunctionString
S3ObjectVersion string | Aws_CF_FunctionString
Script string | Aws_CF_FunctionString
SourceLocationArn string | Aws_CF_FunctionString
ArtifactS3Location string | Aws_CF_FunctionString required

Provide the s3 bucket output location for test results

Schedule object required
2 nested properties
Expression string | Aws_CF_FunctionString required
DurationInSeconds string | Aws_CF_FunctionString
ExecutionRoleArn string | Aws_CF_FunctionString required

Lambda Execution role used to run your canaries

RuntimeVersion string | Aws_CF_FunctionString required

Runtime version of Synthetics Library

ArtifactConfig object
1 nested properties
S3Encryption object
2 nested properties
EncryptionMode string | Aws_CF_FunctionString

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

KmsKeyArn string | Aws_CF_FunctionString

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.

SuccessRetentionPeriod integer

Retention period of successful canary runs represented in number of days

FailureRetentionPeriod integer

Retention period of failed canary runs represented in number of days

Tags Tag[]
VPCConfig object
3 nested properties
SubnetIds string[] required
SecurityGroupIds string[] required
VpcId string | Aws_CF_FunctionString
RunConfig object
4 nested properties
TimeoutInSeconds integer

Provide maximum canary timeout per run in seconds

MemoryInMB integer

Provide maximum memory available for canary in MB

ActiveTracing boolean

Enable active tracing if set to true

EnvironmentVariables object

Environment variable key-value pairs.

StartCanaryAfterCreation boolean

Runs canary if set to True. Default is False

VisualReference object
2 nested properties
BaseCanaryRunId string | Aws_CF_FunctionString required

Canary run id to be used as base reference for visual testing

BaseScreenshots BaseScreenshot[]

List of screenshots used as base reference for visual testing

DeleteLambdaResourcesOnCanaryDeletion boolean

Deletes associated lambda resources created by Synthetics if set to True. Default is False

Definitions

Schedule object
Expression string | Aws_CF_FunctionString required
DurationInSeconds string | Aws_CF_FunctionString
Code object
Handler string | Aws_CF_FunctionString required
S3Bucket string | Aws_CF_FunctionString
S3Key string | Aws_CF_FunctionString
S3ObjectVersion string | Aws_CF_FunctionString
Script string | Aws_CF_FunctionString
SourceLocationArn string | Aws_CF_FunctionString
Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

VPCConfig object
SubnetIds string[] required
SecurityGroupIds string[] required
VpcId string | Aws_CF_FunctionString
RunConfig object
TimeoutInSeconds integer

Provide maximum canary timeout per run in seconds

MemoryInMB integer

Provide maximum memory available for canary in MB

ActiveTracing boolean

Enable active tracing if set to true

EnvironmentVariables object

Environment variable key-value pairs.

VisualReference object
BaseCanaryRunId string | Aws_CF_FunctionString required

Canary run id to be used as base reference for visual testing

BaseScreenshots BaseScreenshot[]

List of screenshots used as base reference for visual testing

BaseScreenshot object
ScreenshotName string | Aws_CF_FunctionString required

Name of the screenshot to be used as base reference for visual testing

IgnoreCoordinates string[]

List of coordinates of rectangles to be ignored during visual testing

ArtifactConfig object
S3Encryption object
2 nested properties
EncryptionMode string | Aws_CF_FunctionString

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

KmsKeyArn string | Aws_CF_FunctionString

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.

S3Encryption object
EncryptionMode string | Aws_CF_FunctionString

Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.

KmsKeyArn string | Aws_CF_FunctionString

KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.