Skip to content
v2.275.0

GroupProps Struct ​

Properties for defining a CloudWatch Synthetics Group.

Example ​

ts
// First, declare your canaries
declare const canary1: synthetics.ICanary;
declare const canary2: synthetics.ICanary;

const group = new synthetics.Group(this, 'MyCanaryGroup', {
  groupName: 'production-canaries',
  canaries: [canary1, canary2],
});

Properties ​

canariesoptionalICanary[]canariesoptionaltyping.List[ICanary]canariesoptionalList<ICanary>CanariesoptionalICanary[]Canariesoptional*[]ICanary#
List of canaries to associate with this group.

Default: No canaries are associated with the group initially

Each group can contain as many as 10 canaries.

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

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

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