Class CfnThingGroup

Creates a new thing group.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnThingGroup

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnThingGroup : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnThingGroup Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

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?)

Creates a new thing group.

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	Creates a new thing group.
ParentGroupName	The parent thing group name.
QueryString	The dynamic thing group search query string.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	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>)	Creates a new thing group.

Constructors

CfnThingGroup(Construct, string, ICfnThingGroupProps?)

Creates a new thing group.

public CfnThingGroup(Construct scope, string id, ICfnThingGroupProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnThingGroupProps

Resource properties.

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

Properties

AttrArn

The thing group ARN.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrId

The thing group ID.

public virtual string AttrId { get; }

Property Value

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

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new thing group.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

ParentGroupName

The parent thing group name.

public virtual string? ParentGroupName { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

QueryString

The dynamic thing group search query string.

public virtual string? QueryString { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

ThingGroupName

The thing group name.

public virtual string? ThingGroupName { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

ThingGroupProperties

Thing group properties.

public virtual object? ThingGroupProperties { get; set; }

Property Value

object

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

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.

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new thing group.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for information about authorizing control plane actions.

Requires permission to access the CreateThingGroup action.

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

CloudformationResource: AWS::IoT::ThingGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable