CfnThingGroupProps

class aws_cdk.aws_iot.CfnThingGroupProps(*, parent_group_name=None, query_string=None, tags=None, thing_group_name=None, thing_group_properties=None)

Bases: object

Properties for defining a CfnThingGroup.

Parameters:
  • parent_group_name (Optional[str]) – The parent thing group name. A Dynamic Thing Group does not have parentGroupName defined.

  • query_string (Optional[str]) – The dynamic thing group search query string. The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the thing group or dynamic thing group.

  • thing_group_name (Optional[str]) – The thing group name.

  • thing_group_properties (Union[IResolvable, ThingGroupPropertiesProperty, Dict[str, Any], None]) – Thing group properties.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html

ExampleMetadata:

fixture=_generated

Example:

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

cfn_thing_group_props = iot.CfnThingGroupProps(
    parent_group_name="parentGroupName",
    query_string="queryString",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thing_group_name="thingGroupName",
    thing_group_properties=iot.CfnThingGroup.ThingGroupPropertiesProperty(
        attribute_payload=iot.CfnThingGroup.AttributePayloadProperty(
            attributes={
                "attributes_key": "attributes"
            }
        ),
        thing_group_description="thingGroupDescription"
    )
)

Attributes

parent_group_name

The parent thing group name.

A Dynamic Thing Group does not have parentGroupName defined.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-parentgroupname

query_string

The dynamic thing group search query string.

The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-querystring

tags

Metadata which can be used to manage the thing group or dynamic thing group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-tags

thing_group_name

The thing group name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-thinggroupname

thing_group_properties

Thing group properties.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-thinggroupproperties