Package software.amazon.awscdk.services.iot

Interface CfnThingGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnThingGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:00.226Z")
@Stability(Stable)
public interface CfnThingGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnThingGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnThingGroupProps cfnThingGroupProps = CfnThingGroupProps.builder()
         .parentGroupName("parentGroupName")
         .queryString("queryString")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thingGroupName("thingGroupName")
         .thingGroupProperties(ThingGroupPropertiesProperty.builder()
                 .attributePayload(AttributePayloadProperty.builder()
                         .attributes(Map.of(
                                 "attributesKey", "attributes"))
                         .build())
                 .thingGroupDescription("thingGroupDescription")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnThingGroupProps.Builder	A builder for CfnThingGroupProps
static final class	CfnThingGroupProps.Jsii$Proxy	An implementation for CfnThingGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnThingGroupProps.Builder	builder()
default String	getParentGroupName()	The parent thing group name.
default String	getQueryString()	The dynamic thing group search query string.
default List<CfnTag>	getTags()	Metadata which can be used to manage the thing group or dynamic thing group.
default String	getThingGroupName()	The thing group name.
default Object	getThingGroupProperties()	Thing group properties.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParentGroupName

@Stability(Stable)
@Nullable
default String getParentGroupName()

The parent thing group name.

A Dynamic Thing Group does not have parentGroupName defined.

See Also:

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

getQueryString

@Stability(Stable)
@Nullable
default String getQueryString()

The dynamic thing group search query string.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

getThingGroupName

@Stability(Stable)
@Nullable
default String getThingGroupName()

The thing group name.

See Also:

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

getThingGroupProperties

@Stability(Stable)
@Nullable
default Object getThingGroupProperties()

Thing group properties.

See Also:

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

builder

@Stability(Stable)
static CfnThingGroupProps.Builder builder()

Returns:

a CfnThingGroupProps.Builder of CfnThingGroupProps