Package software.amazon.awscdk.services.synthetics

Class Group

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.synthetics.Group

All Implemented Interfaces:

IEnvironmentAware, IGroupRef, IResource, IGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-24T20:29:38.599Z")
@Stability(Stable)
public class Group
extends Resource
implements IGroup

Define a new CloudWatch Synthetics Group.

Groups allow you to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Example:

 ICanary canary;
 Group group = new Group(this, "MyCanaryGroup");
 // Add canary to group
 group.addCanary(canary);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Group.Builder	A fluent builder for Group.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.synthetics.IGroup

IGroup.Jsii$Default, IGroup.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Group(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Group(software.amazon.jsii.JsiiObjectRef objRef)
	Group(software.constructs.Construct scope, String id)
	Group(software.constructs.Construct scope, String id, GroupProps props)

Method Summary

Modifier and Type	Method	Description
void	addCanary(ICanary canary)	Add a canary to this group.
static IGroup	fromGroupArn(software.constructs.Construct scope, String id, String groupArn)	Import an existing group by ARN.
static IGroup	fromGroupName(software.constructs.Construct scope, String id, String groupName)	Import an existing group by name.
List<ICanary>	getCanaries()	Get all canaries associated with this group.
String	getGroupArn()	The ARN of the group.
String	getGroupId()	The ID of the group.
String	getGroupName()	The name of the group.
GroupReference	getGroupRef()	A reference to the group.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

Group

protected Group(software.amazon.jsii.JsiiObjectRef objRef)

Group

protected Group(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Group

@Stability(Stable)
public Group(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 GroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Group

@Stability(Stable)
public Group(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromGroupArn

@Stability(Stable)
@NotNull
public static IGroup fromGroupArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String groupArn)

Import an existing group by ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

groupArn - This parameter is required.

fromGroupName

@Stability(Stable)
@NotNull
public static IGroup fromGroupName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String groupName)

Import an existing group by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

groupName - This parameter is required.

addCanary

@Stability(Stable)
public void addCanary(@NotNull
 ICanary canary)

Add a canary to this group.

Parameters:

canary - The canary to add to the group [disable-awslint:prefer-ref-interface]. This parameter is required.

getCanaries

@Stability(Stable)
@NotNull
public List<ICanary> getCanaries()

Get all canaries associated with this group.

getGroupArn

@Stability(Stable)
@NotNull
public String getGroupArn()

The ARN of the group.

Specified by:

getGroupArn in interface IGroup

getGroupId

@Stability(Stable)
@NotNull
public String getGroupId()

The ID of the group.

Specified by:

getGroupId in interface IGroup

getGroupName

@Stability(Stable)
@NotNull
public String getGroupName()

The name of the group.

Specified by:

getGroupName in interface IGroup

getGroupRef

@Stability(Stable)
@NotNull
public GroupReference getGroupRef()

A reference to the group.

Specified by:

getGroupRef in interface IGroupRef