AWS Fundamentals Logo
AWS Fundamentals
AWS::Synthetics::Canary

Synthetics Canary

Resource Type definition for AWS::Synthetics::Canary

Properties

20 configurable properties. 6 required. Click a row to see details.

Filter:
PropertyTypeFlags
ArtifactS3Location
string
Required
Code
Code
Required
ExecutionRoleArn
string
Required
Name
string
RequiredCreate-only
RuntimeVersion
string
Required
Schedule
Schedule
Required
ArtifactConfig
ArtifactConfig
BrowserConfigs
Array<BrowserConfig>
DeleteLambdaResourcesOnCanaryDeletion
boolean
Write-onlyDeprecated
DryRunAndUpdate
boolean
Write-only
FailureRetentionPeriod
integer
ProvisionedResourceCleanup
string
ResourcesToReplicateTags
Array<string>
Write-only
RunConfig
RunConfig
StartCanaryAfterCreation
boolean
Write-only
SuccessRetentionPeriod
integer
Tags
Array<Tag>
VisualReference
VisualReference
Write-onlyDeprecated
VisualReferences
Array<VisualReference>
Write-only
VPCConfig
VPCConfig

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
IdstringId of the canary
StatestringState of the canary

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Synthetics::Canary

Resources:
  MyResource:
    Type: AWS::Synthetics::Canary
    Properties:
      Name: "my-name"
      Code: "value"
      ArtifactS3Location: "value"
      ExecutionRoleArn: "arn:aws:service:region:account:resource"
      Schedule: "value"
      RuntimeVersion: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

synthetics:CreateCanarysynthetics:StartCanarysynthetics:GetCanarysynthetics:TagResources3:CreateBuckets3:GetObjects3:GetObjectVersions3:PutBucketEncryption

update

synthetics:UpdateCanarysynthetics:StartCanarysynthetics:StartCanaryDryRunsynthetics:StopCanarysynthetics:GetCanarysynthetics:GetCanaryRunssynthetics:TagResourcesynthetics:UntagResource

read

synthetics:GetCanarysynthetics:DescribeCanariessynthetics:ListTagsForResourceiam:ListRoless3:ListAllMyBucketss3:GetBucketLocation

delete

synthetics:DeleteCanarysynthetics:GetCanarylambda:DeleteFunctionlambda:DeleteLayerVersion

list

synthetics:DescribeCanaries

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceSynthetics
Properties22
Required6
TaggingSupported
Primary IDName

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

Name

Related Resources

External Links