Class CfnThingGroup
A CloudFormation AWS::IoT::ThingGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnThingGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnThingGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThingGroup action.
CloudformationResource: AWS::IoT::ThingGroup
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnThingGroup = new CfnThingGroup(this, "MyCfnThingGroup", new CfnThingGroupProps {
ParentGroupName = "parentGroupName",
QueryString = "queryString",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
ThingGroupName = "thingGroupName",
ThingGroupProperties = new ThingGroupPropertiesProperty {
AttributePayload = new AttributePayloadProperty {
Attributes = new Dictionary<string, string> {
{ "attributesKey", "attributes" }
}
},
ThingGroupDescription = "thingGroupDescription"
}
});
Synopsis
Constructors
CfnThingGroup(Construct, String, ICfnThingGroupProps) | Create a new |
CfnThingGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnThingGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The thing group ARN. |
AttrId | The thing group ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ParentGroupName | The parent thing group name. |
QueryString | The dynamic thing group search query string. |
Tags | Metadata which can be used to manage the thing group or dynamic thing group. |
ThingGroupName | The thing group name. |
ThingGroupProperties | Thing group properties. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnThingGroup(Construct, String, ICfnThingGroupProps)
Create a new AWS::IoT::ThingGroup
.
public CfnThingGroup(Construct scope, string id, ICfnThingGroupProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnThingGroupProps
- resource properties.
CfnThingGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnThingGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnThingGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnThingGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The thing group ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The thing group ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ParentGroupName
The parent thing group name.
public virtual string ParentGroupName { get; set; }
Property Value
System.String
Remarks
A Dynamic Thing Group does not have parentGroupName
defined.
QueryString
The dynamic thing group search query string.
public virtual string QueryString { get; set; }
Property Value
System.String
Remarks
The queryString
attribute is required for CreateDynamicThingGroup
. The queryString
attribute is not required for CreateThingGroup
.
Tags
Metadata which can be used to manage the thing group or dynamic thing group.
public virtual TagManager Tags { get; }
Property Value
Remarks
ThingGroupName
The thing group name.
public virtual string ThingGroupName { get; set; }
Property Value
System.String
Remarks
ThingGroupProperties
Thing group properties.
public virtual object ThingGroupProperties { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>