aws-cdk-lib.aws_synthetics.CfnGroupProps

interface CfnGroupProps

LanguageType name
.NETAmazon.CDK.AWS.Synthetics.CfnGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnGroupProps
Javasoftware.amazon.awscdk.services.synthetics.CfnGroupProps
Pythonaws_cdk.aws_synthetics.CfnGroupProps
TypeScript aws-cdk-lib » aws_synthetics » CfnGroupProps

Properties for defining a CfnGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from 'aws-cdk-lib';
const cfnGroupProps: synthetics.CfnGroupProps = {
  name: 'name',

  // the properties below are optional
  resourceArns: ['resourceArns'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringA name for the group. It can include any Unicode characters.
resourceArns?string[]The ARNs of the canaries that you want to associate with this group.
tags?CfnTag[]The list of key-value pairs that are associated with the group.

name

Type: 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.


resourceArns?

Type: string[] (optional)

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


tags?

Type: CfnTag[] (optional)

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