CfnThingGroupPropsMixin

class aws_cdk.mixins_preview.aws_iot.mixins.CfnThingGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

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. .. epigraph:

This is a control plane operation. See `Authorization <https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html>`_ 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
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iot import mixins as iot_mixins

cfn_thing_group_props_mixin = iot_mixins.CfnThingGroupPropsMixin(iot_mixins.CfnThingGroupMixinProps(
    parent_group_name="parentGroupName",
    query_string="queryString",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thing_group_name="thingGroupName",
    thing_group_properties=iot_mixins.CfnThingGroupPropsMixin.ThingGroupPropertiesProperty(
        attribute_payload=iot_mixins.CfnThingGroupPropsMixin.AttributePayloadProperty(
            attributes={
                "attributes_key": "attributes"
            }
        ),
        thing_group_description="thingGroupDescription"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoT::ThingGroup.

Parameters:

props (Union[CfnThingGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['parentGroupName', 'queryString', 'tags', 'thingGroupName', 'thingGroupProperties']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AttributePayloadProperty

class CfnThingGroupPropsMixin.AttributePayloadProperty(*, attributes=None)

Bases: object

The attribute payload.

Parameters:: attributes (Union[Mapping[str, str], IResolvable, None]) – A JSON string containing up to three key-value pair in JSON format. For example:. {\"attributes\":{\"string1\":\"string2\"}}
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-attributepayload.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.mixins_preview.aws_iot import mixins as iot_mixins

attribute_payload_property = iot_mixins.CfnThingGroupPropsMixin.AttributePayloadProperty(
    attributes={
        "attributes_key": "attributes"
    }
)

Attributes

attributes

.

{\"attributes\":{\"string1\":\"string2\"}}

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-attributepayload.html#cfn-iot-thinggroup-attributepayload-attributes
Type:: A JSON string containing up to three key-value pair in JSON format. For example

ThingGroupPropertiesProperty

class CfnThingGroupPropsMixin.ThingGroupPropertiesProperty(*, attribute_payload=None, thing_group_description=None)

Bases: object

Thing group properties.

Parameters:

attribute_payload (Union[IResolvable, AttributePayloadProperty, Dict[str, Any], None]) – The thing group attributes in JSON format.
thing_group_description (Optional[str]) – The thing group description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-thinggroupproperties.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.mixins_preview.aws_iot import mixins as iot_mixins

thing_group_properties_property = iot_mixins.CfnThingGroupPropsMixin.ThingGroupPropertiesProperty(
    attribute_payload=iot_mixins.CfnThingGroupPropsMixin.AttributePayloadProperty(
        attributes={
            "attributes_key": "attributes"
        }
    ),
    thing_group_description="thingGroupDescription"
)

Attributes

attribute_payload

The thing group attributes in JSON format.

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

thing_group_description

The thing group description.

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