CfnThingPropsMixin
- class aws_cdk.mixins_preview.aws_iot.mixins.CfnThingPropsMixin(props, *, strategy=None)
Bases:
MixinUse the
AWS::IoT::Thingresource to declare an AWS IoT thing.For information about working with things, see How AWS IoT Works and Device Registry for AWS IoT in the AWS IoT Developer Guide .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html
- CloudformationResource:
AWS::IoT::Thing
- 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_props_mixin = iot_mixins.CfnThingPropsMixin(iot_mixins.CfnThingMixinProps( attribute_payload=iot_mixins.CfnThingPropsMixin.AttributePayloadProperty( attributes={ "attributes_key": "attributes" } ), thing_name="thingName" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::IoT::Thing.- Parameters:
props (
Union[CfnThingMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['attributePayload', 'thingName']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AttributePayloadProperty
- class CfnThingPropsMixin.AttributePayloadProperty(*, attributes=None)
Bases:
objectThe AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs.
AttributePayload is a property of the AWS::IoT::Thing resource.
- 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:
- 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.CfnThingPropsMixin.AttributePayloadProperty( attributes={ "attributes_key": "attributes" } )
Attributes
- attributes
.
{\"attributes\":{\"string1\":\"string2\"}}- See:
- Type:
A JSON string containing up to three key-value pair in JSON format. For example