CfnGroupProps

class aws_cdk.aws_synthetics.CfnGroupProps(*, name, resource_arns=None, tags=None)

Bases: object

Properties for defining a CfnGroup.

Parameters:

name (str) – 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.
resource_arns (Optional[Sequence[str]]) – The ARNs of the canaries that you want to associate with this group.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The list of key-value pairs that are associated with the group.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_synthetics as synthetics

cfn_group_props = synthetics.CfnGroupProps(
    name="name",

    # the properties below are optional
    resource_arns=["resourceArns"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

name

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-name

resource_arns

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-resourcearns

tags

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-tags