Group

class aws_cdk.aws_synthetics.Group(scope, id, *, canaries=None, group_name=None)

Bases: Resource

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.

ExampleMetadata:: infused

Example:

# canary: synthetics.ICanary

group = synthetics.Group(self, "MyCanaryGroup")

# Add canary to group
group.add_canary(canary)

Parameters:

scope (Construct)
id (str)
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

Methods

add_canary(canary)

Add a canary to this group.

Parameters:: canary (ICanary) – The canary to add to the group [disable-awslint:prefer-ref-interface].
Return type:: None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-synthetics.Group'

canaries: Get all canaries associated with this group.

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

group_arn

The ARN of the group.

Attribute:: true

group_id

The ID of the group.

Attribute:: true

group_name

The name of the group.

Attribute:: true

group_ref: A reference to the group.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_group_arn(scope, id, group_arn)

Import an existing group by ARN.

Parameters:

scope (Construct)
id (str)
group_arn (str)

Return type:

IGroup

classmethod from_group_name(scope, id, group_name)

Import an existing group by name.

Parameters:

scope (Construct)
id (str)
group_name (str)

Return type:

IGroup

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool