GroupProps

class aws_cdk.aws_synthetics.GroupProps(*, canaries=None, group_name=None)

Bases: object

Properties for defining a CloudWatch Synthetics Group.

Parameters:

canaries (Optional[Sequence[ICanary]]) – 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
group_name (Optional[str]) – 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

ExampleMetadata:

infused

Example:

# First, declare your canaries
# canary1: synthetics.ICanary
# canary2: synthetics.ICanary


group = synthetics.Group(self, "MyCanaryGroup",
    group_name="production-canaries",
    canaries=[canary1, canary2]
)

Attributes

canaries

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

group_name

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