canary

Gets an individual canary resource

Overview

Name	canary
Type	Resource
Description	canary
Id	awscc.synthetics.canary

Fields

Name	Datatype	Description
name	string	Name of the canary.
id	string	Id of the canary
state	string	State of the canary
code	object	Provide the canary script source
artifact_s3_location	string	Provide the s3 bucket output location for test results
artifact_config	object	Provide artifact configuration
schedule	object	Frequency to run your canaries
execution_role_arn	string	Lambda Execution role used to run your canaries
runtime_version	string	Runtime version of Synthetics Library
success_retention_period	integer	Retention period of successful canary runs represented in number of days
failure_retention_period	integer	Retention period of failed canary runs represented in number of days
tags	array
vpc_config	object	Provide VPC Configuration if enabled.
run_config	object	Provide canary run configuration
start_canary_after_creation	boolean	Runs canary if set to True. Default is False
visual_reference	object	Visual reference configuration for visual testing
delete_lambda_resources_on_canary_deletion	boolean	Deletes associated lambda resources created by Synthetics if set to True. Default is False
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
name,
id,
state,
code,
artifact_s3_location,
artifact_config,
schedule,
execution_role_arn,
runtime_version,
success_retention_period,
failure_retention_period,
tags,
vpc_config,
run_config,
start_canary_after_creation,
visual_reference,
delete_lambda_resources_on_canary_deletion
FROM awscc.synthetics.canary
WHERE data__Identifier = '<Name>';

Permissions

To operate on the canary resource, the following permissions are required:

Update

synthetics:UpdateCanary,
synthetics:StartCanary,
synthetics:StopCanary,
synthetics:GetCanary,
synthetics:TagResource,
synthetics:UntagResource,
s3:GetObject,
s3:GetObjectVersion,
s3:PutBucketEncryption,
s3:PutEncryptionConfiguration,
s3:GetBucketLocation,
lambda:AddPermission,
lambda:PublishVersion,
lambda:UpdateFunctionConfiguration,
lambda:GetFunctionConfiguration,
lambda:GetLayerVersionByArn,
lambda:GetLayerVersion,
lambda:PublishLayerVersion,
iam:PassRole

Read

synthetics:GetCanary,
synthetics:DescribeCanaries,
synthetics:ListTagsForResource,
iam:ListRoles,
s3:ListAllMyBuckets,
s3:GetBucketLocation

Delete

synthetics:DeleteCanary,
synthetics:GetCanary