Package software.amazon.awscdk.services.synthetics

Interface GroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GroupProps.Jsii$Proxy

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

Properties for defining a CloudWatch Synthetics Group.

Example:

 // First, declare your canaries
 ICanary canary1;
 ICanary canary2;
 Group group = Group.Builder.create(this, "MyCanaryGroup")
         .groupName("production-canaries")
         .canaries(List.of(canary1, canary2))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GroupProps.Builder	builder()
default List<ICanary>	getCanaries()	List of canaries to associate with this group.
default String	getGroupName()	A name for the group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCanaries

@Stability(Stable)
@Nullable
default List<ICanary> getCanaries()

List of canaries to associate with this group.

Each group can contain as many as 10 canaries.

Default: - No canaries are associated with the group initially

getGroupName

@Stability(Stable)
@Nullable
default String getGroupName()

A name for the group. Must contain only lowercase alphanumeric characters, hyphens, or underscores, and be at most 64 characters.

The names for all groups in your account, across all Regions, must be unique.

Default: - A unique name will be generated from the construct ID

builder

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

Returns:

a GroupProps.Builder of GroupProps