Package software.amazon.awscdk.cfnpropertymixins.services.synthetics

Class CfnGroupPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.synthetics.CfnGroupPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-19T12:55:27.132Z") @Stability(Stable) public class CfnGroupPropsMixin extends Mixin implements software.constructs.IMixin
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.synthetics.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnGroupPropsMixin cfnGroupPropsMixin = CfnGroupPropsMixin.Builder.create(CfnGroupMixinProps.builder()
         .name("name")
         .resourceArns(List.of("resourceArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnGroupPropsMixin.Builder
    A fluent builder for CfnGroupPropsMixin.

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

    software.amazon.jsii.JsiiObject.InitializationMode

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

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnGroupPropsMixin(CfnGroupMixinProps props)
    Create a mixin to apply properties to AWS::Synthetics::Group.
     
    CfnGroupPropsMixin(CfnGroupMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::Synthetics::Group.
    protected
    CfnGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnGroupMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnGroupPropsMixin

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

    • CfnGroupPropsMixin

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

    • CfnGroupPropsMixin

      @Stability(Stable) public CfnGroupPropsMixin(@NotNull CfnGroupMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Synthetics::Group.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnGroupPropsMixin

      @Stability(Stable) public CfnGroupPropsMixin(@NotNull CfnGroupMixinProps props)
      Create a mixin to apply properties to AWS::Synthetics::Group.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnGroupMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()