Package software.amazon.awscdk.services.synthetics

Interface ICanary

All Superinterfaces:

ICanaryRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ICanary.Jsii$Default

All Known Implementing Classes:

Canary, ICanary.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-24T20:29:38.599Z")
@Stability(Stable)
public interface ICanary
extends software.amazon.jsii.JsiiSerializable, IResource, ICanaryRef

Represents a CloudWatch Synthetics Canary.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ICanary.Jsii$Default	Internal default implementation for ICanary.
static final class	ICanary.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getCanaryArn()	The ARN of the canary.
String	getCanaryId()	The ID of the canary.
String	getCanaryName()	The name of the canary.

Methods inherited from interface software.amazon.awscdk.interfaces.synthetics.ICanaryRef

getCanaryRef

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCanaryArn

@Stability(Stable)
@NotNull
String getCanaryArn()

The ARN of the canary.

getCanaryId

@Stability(Stable)
@NotNull
String getCanaryId()

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.

getCanaryName

@Stability(Stable)
@NotNull
String getCanaryName()

The name of the canary.