| active_tracing |
Whether this canary is to use active AWS X-Ray tracing when it runs. |
string |
null |
no |
| artifact_bucket_name |
Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. |
string |
n/a |
yes |
| canary_name |
Name for the canary. Has a maximum length of 21 characters. |
string |
n/a |
yes |
| duration_in_seconds |
Duration in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. |
number |
null |
no |
| environment_variables |
Map of environment variables that are accessible from the canary during execution. |
map(string) |
null |
no |
| failure_retention_period |
Number of days to retain data about failed runs of this canary. |
number |
14 |
no |
| handler |
Entry point to use for the source code when running the canary. This value must end with the string .handler |
string |
n/a |
yes |
| memory_in_mb |
Maximum amount of memory available to the canary while it is running, in MB. |
string |
null |
no |
| region |
AWS region |
string |
n/a |
yes |
| runtime_version |
Runtime version to use for the canary. Versions change often so consult the Amazon CloudWatch documentation for the latest valid versions. |
string |
"syn-python-selenium-1.3" |
no |
| schedule_expression |
Configuration block providing how often the canary is to run and when these test runs are to stop |
string |
n/a |
yes |
| security_group_ids |
IDs of the security groups for this canary |
list(string) |
null |
no |
| subnet_ids |
IDs of the subnets where this canary is to run |
list(string) |
null |
no |
| success_retention_period |
Number of days to retain data about successful runs of this canary. |
number |
2 |
no |
| tags |
Key-value map of resource tags |
map(string) |
null |
no |
| timeout_in_seconds |
Number of seconds the canary is allowed to run before it must stop. |
string |
null |
no |
| zip_file_path |
ZIP file that contains the script. |
string |
n/a |
yes |