class CfnGroupPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Synthetics.Mixins.CfnGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssynthetics/mixins#CfnGroupPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.synthetics.mixins.CfnGroupPropsMixin
Python	aws_cdk.mixins_preview.aws_synthetics.mixins.CfnGroupPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_synthetics » mixins » CfnGroupPropsMixin

Implements IMixin

Extends Mixin

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as synthetics_mixins } from '@aws-cdk/mixins-preview/aws-synthetics';
const cfnGroupPropsMixin = new synthetics_mixins.CfnGroupPropsMixin({
  name: 'name',
  resourceArns: ['resourceArns'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnGroupPropsMixin(props: CfnGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Synthetics::Group.

Properties

Name	Type	Description
props	CfnGroupMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnGroupMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.