Creates a new thing group. A dynamic thing group is created if the resource template
contains the QueryString attribute. A dynamic thing group will not contain the
ParentGroupName attribute. A static thing group and dynamic thing group
can't be converted to each other via the addition or removal of the
QueryString attribute.
Note
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThingGroup action.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::IoT::ThingGroup",
"Properties" : {
"ParentGroupName" : String,
"QueryString" : String,
"Tags" : [ Tag, ... ],
"ThingGroupName" : String,
"ThingGroupProperties" : ThingGroupProperties
}
}
YAML
Type: AWS::IoT::ThingGroup
Properties:
ParentGroupName: String
QueryString:
String
Tags:
- Tag
ThingGroupName: String
ThingGroupProperties:
ThingGroupProperties
Properties
ParentGroupName-
The parent thing group name.
A Dynamic Thing Group does not have
parentGroupNamedefined.Required: No
Type: String
Pattern:
[a-zA-Z0-9:_-]+Minimum:
1Maximum:
128Update requires: Replacement
QueryString-
The dynamic thing group search query string.
The
queryStringattribute is required forCreateDynamicThingGroup. ThequeryStringattribute is not required forCreateThingGroup.Required: No
Type: String
Minimum:
1Maximum:
1000Update requires: No interruption
-
Metadata which can be used to manage the thing group or dynamic thing group.
Required: No
Type: Array of Tag
Maximum:
50Update requires: No interruption
ThingGroupName-
The thing group name.
Required: No
Type: String
Pattern:
[a-zA-Z0-9:_-]+Minimum:
1Maximum:
128Update requires: Replacement
ThingGroupProperties-
Thing group properties.
Required: No
Type: ThingGroupProperties
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the thing group id.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
Arn-
The thing group ARN.
Id-
The thing group ID.
