interface GroupProps

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

Properties for defining a CloudWatch Synthetics Group.

Example

// 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

Name	Type	Description
canaries?	ICanary[]	List of canaries to associate with this group.
groupName?	string	A name for the group. Must contain only lowercase alphanumeric characters, hyphens, or underscores, and be at most 64 characters.

---

canaries?

Type: ICanary[] (optional, default: No canaries are associated with the group initially)

List of canaries to associate with this group.

Each group can contain as many as 10 canaries.

---

groupName?

Type: string (optional, default: A unique name will be generated from the construct ID)

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.