Package software.amazon.awscdk.services.synthetics

Interface CanaryReference

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CanaryReference.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-22T11:33:17.138Z")
@Stability(Stable)
public interface CanaryReference
extends software.amazon.jsii.JsiiSerializable

A reference to a Canary resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.synthetics.*;
 CanaryReference canaryReference = CanaryReference.builder()
         .canaryName("canaryName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CanaryReference.Builder	A builder for CanaryReference
static final class	CanaryReference.Jsii$Proxy	An implementation for CanaryReference

Method Summary

Modifier and Type	Method	Description
static CanaryReference.Builder	builder()
String	getCanaryName()	The Name of the Canary resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCanaryName

@Stability(Stable)
@NotNull
String getCanaryName()

The Name of the Canary resource.

builder

@Stability(Stable)
static CanaryReference.Builder builder()

Returns:

a CanaryReference.Builder of CanaryReference