aws-cdk-lib.aws_synthetics.CfnCanary

class CfnCanary (construct)

LanguageType name
.NETAmazon.CDK.AWS.Synthetics.CfnCanary
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnCanary
Javasoftware.amazon.awscdk.services.synthetics.CfnCanary
Pythonaws_cdk.aws_synthetics.CfnCanary
TypeScript aws-cdk-lib » aws_synthetics » CfnCanary

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::Synthetics::Canary.

Creates or updates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the the iam:CreateRole , iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions .

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from 'aws-cdk-lib';
const cfnCanary = new synthetics.CfnCanary(this, 'MyCfnCanary', {
  artifactS3Location: 'artifactS3Location',
  code: {
    handler: 'handler',

    // the properties below are optional
    s3Bucket: 's3Bucket',
    s3Key: 's3Key',
    s3ObjectVersion: 's3ObjectVersion',
    script: 'script',
    sourceLocationArn: 'sourceLocationArn',
  },
  executionRoleArn: 'executionRoleArn',
  name: 'name',
  runtimeVersion: 'runtimeVersion',
  schedule: {
    expression: 'expression',

    // the properties below are optional
    durationInSeconds: 'durationInSeconds',
  },

  // the properties below are optional
  artifactConfig: {
    s3Encryption: {
      encryptionMode: 'encryptionMode',
      kmsKeyArn: 'kmsKeyArn',
    },
  },
  deleteLambdaResourcesOnCanaryDeletion: false,
  failureRetentionPeriod: 123,
  runConfig: {
    activeTracing: false,
    environmentVariables: {
      environmentVariablesKey: 'environmentVariables',
    },
    memoryInMb: 123,
    timeoutInSeconds: 123,
  },
  startCanaryAfterCreation: false,
  successRetentionPeriod: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  visualReference: {
    baseCanaryRunId: 'baseCanaryRunId',

    // the properties below are optional
    baseScreenshots: [{
      screenshotName: 'screenshotName',

      // the properties below are optional
      ignoreCoordinates: ['ignoreCoordinates'],
    }],
  },
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],

    // the properties below are optional
    vpcId: 'vpcId',
  },
});

Initializer

new CfnCanary(scope: Construct, id: string, props: CfnCanaryProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnCanaryProps — - resource properties.

Create a new AWS::Synthetics::Canary.

Construct Props

NameTypeDescription
artifactS3LocationstringThe location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
codeIResolvable | CodePropertyUse this structure to input your script code for the canary.
executionRoleArnstringThe ARN of the IAM role to be used to run the canary.
namestringThe name for this canary.
runtimeVersionstringSpecifies the runtime version to use for the canary.
scheduleIResolvable | SchedulePropertyA structure that contains information about how often the canary is to run, and when these runs are to stop.
artifactConfig?IResolvable | ArtifactConfigPropertyA structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
deleteLambdaResourcesOnCanaryDeletion?boolean | IResolvableAWS::Synthetics::Canary.DeleteLambdaResourcesOnCanaryDeletion.
failureRetentionPeriod?numberThe number of days to retain data about failed runs of this canary.
runConfig?IResolvable | RunConfigPropertyA structure that contains input information for a canary run.
startCanaryAfterCreation?boolean | IResolvableSpecify TRUE to have the canary start making runs immediately after it is created.
successRetentionPeriod?numberThe number of days to retain data about successful runs of this canary.
tags?CfnTag[]The list of key-value pairs that are associated with the canary.
visualReference?IResolvable | VisualReferencePropertyIf this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
vpcConfig?IResolvable | VPCConfigPropertyIf this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.

artifactS3Location

Type: string

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.

Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including s3:// at the beginning of the path.


code

Type: IResolvable | CodeProperty

Use this structure to input your script code for the canary.

This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of Script .


executionRoleArn

Type: string

The ARN of the IAM role to be used to run the canary.

This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject
  • s3:GetBucketLocation
  • s3:ListAllMyBuckets
  • cloudwatch:PutMetricData
  • logs:CreateLogGroup
  • logs:CreateLogStream
  • logs:PutLogEvents

name

Type: string

The name for this canary.

Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries .


runtimeVersion

Type: string

Specifies the runtime version to use for the canary.

For more information about runtime versions, see Canary Runtime Versions .


schedule

Type: IResolvable | ScheduleProperty

A structure that contains information about how often the canary is to run, and when these runs are to stop.


artifactConfig?

Type: IResolvable | ArtifactConfigProperty (optional)

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.


deleteLambdaResourcesOnCanaryDeletion?

Type: boolean | IResolvable (optional)

AWS::Synthetics::Canary.DeleteLambdaResourcesOnCanaryDeletion.


failureRetentionPeriod?

Type: number (optional)

The number of days to retain data about failed runs of this canary.

If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.


runConfig?

Type: IResolvable | RunConfigProperty (optional)

A structure that contains input information for a canary run.

If you omit this structure, the frequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.


startCanaryAfterCreation?

Type: boolean | IResolvable (optional)

Specify TRUE to have the canary start making runs immediately after it is created.

A canary that you create using CloudFormation can't be used to monitor the CloudFormation stack that creates the canary or to roll back that stack if there is a failure.


successRetentionPeriod?

Type: number (optional)

The number of days to retain data about successful runs of this canary.

If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.


tags?

Type: CfnTag[] (optional)

The list of key-value pairs that are associated with the canary.


visualReference?

Type: IResolvable | VisualReferenceProperty (optional)

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.


vpcConfig?

Type: IResolvable | VPCConfigProperty (optional)

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.

For more information, see Running a Canary in a VPC .

Properties

NameTypeDescription
artifactS3LocationstringThe location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
attrCodeSourceLocationArnstringRef returns the ARN of the Lambda layer where Synthetics stores the canary script code.
attrIdstringThe ID of the canary.
attrStatestringThe state of the canary.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
codeIResolvable | CodePropertyUse this structure to input your script code for the canary.
creationStackstring[]
executionRoleArnstringThe ARN of the IAM role to be used to run the canary.
logicalIdstringThe logical ID for this CloudFormation stack element.
namestringThe name for this canary.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
runtimeVersionstringSpecifies the runtime version to use for the canary.
scheduleIResolvable | SchedulePropertyA structure that contains information about how often the canary is to run, and when these runs are to stop.
stackStackThe stack in which this element is defined.
tagsTagManagerThe list of key-value pairs that are associated with the canary.
artifactConfig?IResolvable | ArtifactConfigPropertyA structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
deleteLambdaResourcesOnCanaryDeletion?boolean | IResolvableAWS::Synthetics::Canary.DeleteLambdaResourcesOnCanaryDeletion.
failureRetentionPeriod?numberThe number of days to retain data about failed runs of this canary.
runConfig?IResolvable | RunConfigPropertyA structure that contains input information for a canary run.
startCanaryAfterCreation?boolean | IResolvableSpecify TRUE to have the canary start making runs immediately after it is created.
successRetentionPeriod?numberThe number of days to retain data about successful runs of this canary.
visualReference?IResolvable | VisualReferencePropertyIf this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
vpcConfig?IResolvable | VPCConfigPropertyIf this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

artifactS3Location

Type: string

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.

Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including s3:// at the beginning of the path.


attrCodeSourceLocationArn

Type: string

Ref returns the ARN of the Lambda layer where Synthetics stores the canary script code.


attrId

Type: string

The ID of the canary.


attrState

Type: string

The state of the canary.

For example, RUNNING .


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


code

Type: IResolvable | CodeProperty

Use this structure to input your script code for the canary.

This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of Script .


creationStack

Type: string[]


executionRoleArn

Type: string

The ARN of the IAM role to be used to run the canary.

This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:

  • s3:PutObject
  • s3:GetBucketLocation
  • s3:ListAllMyBuckets
  • cloudwatch:PutMetricData
  • logs:CreateLogGroup
  • logs:CreateLogStream
  • logs:PutLogEvents

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


name

Type: string

The name for this canary.

Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries .


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


runtimeVersion

Type: string

Specifies the runtime version to use for the canary.

For more information about runtime versions, see Canary Runtime Versions .


schedule

Type: IResolvable | ScheduleProperty

A structure that contains information about how often the canary is to run, and when these runs are to stop.


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

The list of key-value pairs that are associated with the canary.


artifactConfig?

Type: IResolvable | ArtifactConfigProperty (optional)

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.


deleteLambdaResourcesOnCanaryDeletion?

Type: boolean | IResolvable (optional)

AWS::Synthetics::Canary.DeleteLambdaResourcesOnCanaryDeletion.


failureRetentionPeriod?

Type: number (optional)

The number of days to retain data about failed runs of this canary.

If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.


runConfig?

Type: IResolvable | RunConfigProperty (optional)

A structure that contains input information for a canary run.

If you omit this structure, the frequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.


startCanaryAfterCreation?

Type: boolean | IResolvable (optional)

Specify TRUE to have the canary start making runs immediately after it is created.

A canary that you create using CloudFormation can't be used to monitor the CloudFormation stack that creates the canary or to roll back that stack if there is a failure.


successRetentionPeriod?

Type: number (optional)

The number of days to retain data about successful runs of this canary.

If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.


visualReference?

Type: IResolvable | VisualReferenceProperty (optional)

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.


vpcConfig?

Type: IResolvable | VPCConfigProperty (optional)

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.

For more information, see Running a Canary in a VPC .


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }