interface ICanary

Language	Type name
.NET	Amazon.CDK.AWS.Synthetics.ICanary
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#ICanary
Java	software.amazon.awscdk.services.synthetics.ICanary
Python	aws_cdk.aws_synthetics.ICanary
TypeScript (source)	aws-cdk-lib » aws_synthetics » ICanary

Implements IDependable, IConstruct, IEnvironmentAware, IResource, ICanaryRef

Implemented by Canary

Obtainable from Canary.fromCanaryArn(), Canary.fromCanaryName()

Represents a CloudWatch Synthetics Canary.

Properties

Name	Type	Description
canaryArn	string	The ARN of the canary.
canaryId	string	The ID of the canary.
canaryName	string	The name of the canary.
canaryRef🔹	CanaryReference	A reference to a Canary resource.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

canaryArn

Type: string

The ARN of the canary.

---

canaryId

Type: string

The ID of the canary.

For imported canaries, this may be the canary name as a fallback, since the actual ID (a UUID) is not available when importing by name.

---

canaryName

Type: string

The name of the canary.

---

canaryRef🔹

Type: CanaryReference

A reference to a Canary resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
with(...mixins)	Applies one or more mixins to this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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).

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.