AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Synthetics::Group

CfnGroup

Creates or updates a group which you can use 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. Groups are global resources. When you create a group, it is replicated across all AWS Regions, and you can add canaries from any Region to it, and view it in any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view. Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.

Import

import { CfnGroup } from 'aws-cdk-lib/aws-synthetics';

Or use the module namespace:

import * as synthetics from 'aws-cdk-lib/aws-synthetics';
// synthetics.CfnGroup

Properties

Configuration passed to the constructor as CfnGroupProps.

nameRequired
string

A name for the group. It can include any Unicode characters. The names for all groups in your account, across all Regions, must be unique.

resourceArnsOptional
string[]

The ARNs of the canaries that you want to associate with this group.

tagsOptional
CfnTag[]

The list of key-value pairs that are associated with the group.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-synthetics
CFN TypeAWS::Synthetics::Group
Properties3

Related Constructs

External Links