aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.1__py3-none-any.whl

aws_cdk/aws_iot/__init__.py

@@ -12578,10 +12578,10 @@ class CfnThingType(
         '''
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
-        :param deprecate_thing_type: Deprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the `DeprecateThingType <https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`_ action.
+        :param deprecate_thing_type: Deprecates a thing type. You can not associate new things with deprecated thing type. You cannot update ``ThingTypeProperties`` if the thing type is deprecated. Requires permission to access the `DeprecateThingType <https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`_ action.
         :param tags: Metadata which can be used to manage the thing type.
         :param thing_type_name: The name of the thing type.
-        :param thing_type_properties: The thing type properties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names. ``ThingTypeProperties`` can't be updated after the initial creation of the ``ThingType`` .
+        :param thing_type_properties: The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update ``Mqtt5Configuration`` .
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__855c3886be1512886349890e201c5566281b169c77e8a1ea7d540216ec69c482)
@@ -12660,10 +12660,7 @@ class CfnThingType(
     def deprecate_thing_type(
         self,
     ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
-        '''Deprecates a thing type.
-
-        You can not associate new things with deprecated thing type.
-        '''
+        '''Deprecates a thing type.'''
         return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "deprecateThingType"))
 
     @deprecate_thing_type.setter
@@ -12731,8 +12728,9 @@ class CfnThingType(
             *,
             propagating_attributes: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnThingType.PropagatingAttributeProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
         ) -> None:
-            '''
-            :param propagating_attributes: 
+            '''The configuration to add user-defined properties to enrich MQTT 5 messages.
+
+            :param propagating_attributes: An object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-mqtt5configuration.html
             :exampleMetadata: fixture=_generated
@@ -12764,7 +12762,8 @@ class CfnThingType(
         def propagating_attributes(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnThingType.PropagatingAttributeProperty"]]]]:
-            '''
+            '''An object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-mqtt5configuration.html#cfn-iot-thingtype-mqtt5configuration-propagatingattributes
             '''
             result = self._values.get("propagating_attributes")
@@ -12798,10 +12797,11 @@ class CfnThingType(
             connection_attribute: typing.Optional[builtins.str] = None,
             thing_attribute: typing.Optional[builtins.str] = None,
         ) -> None:
-            '''
-            :param user_property_key: 
-            :param connection_attribute: 
-            :param thing_attribute: 
+            '''An object that represents the connection attribute, the thing attribute, and the MQTT 5 user property key.
+
+            :param user_property_key: The key of the MQTT 5 user property, which is a key-value pair.
+            :param connection_attribute: The attribute associated with the connection details.
+            :param thing_attribute: The thing attribute that is propagating for MQTT 5 message enrichment.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html
             :exampleMetadata: fixture=_generated
@@ -12835,7 +12835,8 @@ class CfnThingType(
 
         @builtins.property
         def user_property_key(self) -> builtins.str:
-            '''
+            '''The key of the MQTT 5 user property, which is a key-value pair.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html#cfn-iot-thingtype-propagatingattribute-userpropertykey
             '''
             result = self._values.get("user_property_key")
@@ -12844,7 +12845,8 @@ class CfnThingType(
 
         @builtins.property
         def connection_attribute(self) -> typing.Optional[builtins.str]:
-            '''
+            '''The attribute associated with the connection details.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html#cfn-iot-thingtype-propagatingattribute-connectionattribute
             '''
             result = self._values.get("connection_attribute")
@@ -12852,7 +12854,8 @@ class CfnThingType(
 
         @builtins.property
         def thing_attribute(self) -> typing.Optional[builtins.str]:
-            '''
+            '''The thing attribute that is propagating for MQTT 5 message enrichment.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-propagatingattribute.html#cfn-iot-thingtype-propagatingattribute-thingattribute
             '''
             result = self._values.get("thing_attribute")
@@ -12888,7 +12891,7 @@ class CfnThingType(
         ) -> None:
             '''The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
 
-            :param mqtt5_configuration: 
+            :param mqtt5_configuration: The configuration to add user-defined properties to enrich MQTT 5 messages.
             :param searchable_attributes: A list of searchable thing attribute names.
             :param thing_type_description: The description of the thing type.
 
@@ -12932,7 +12935,8 @@ class CfnThingType(
         def mqtt5_configuration(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnThingType.Mqtt5ConfigurationProperty"]]:
-            '''
+            '''The configuration to add user-defined properties to enrich MQTT 5 messages.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-thingtypeproperties.html#cfn-iot-thingtype-thingtypeproperties-mqtt5configuration
             '''
             result = self._values.get("mqtt5_configuration")
@@ -12989,10 +12993,10 @@ class CfnThingTypeProps:
     ) -> None:
         '''Properties for defining a ``CfnThingType``.
 
-        :param deprecate_thing_type: Deprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the `DeprecateThingType <https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`_ action.
+        :param deprecate_thing_type: Deprecates a thing type. You can not associate new things with deprecated thing type. You cannot update ``ThingTypeProperties`` if the thing type is deprecated. Requires permission to access the `DeprecateThingType <https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`_ action.
         :param tags: Metadata which can be used to manage the thing type.
         :param thing_type_name: The name of the thing type.
-        :param thing_type_properties: The thing type properties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names. ``ThingTypeProperties`` can't be updated after the initial creation of the ``ThingType`` .
+        :param thing_type_properties: The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update ``Mqtt5Configuration`` .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.html
         :exampleMetadata: fixture=_generated
@@ -13045,7 +13049,9 @@ class CfnThingTypeProps:
     def deprecate_thing_type(
         self,
     ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
-        '''Deprecates a thing type. You can not associate new things with deprecated thing type.
+        '''Deprecates a thing type.
+
+        You can not associate new things with deprecated thing type. You cannot update ``ThingTypeProperties`` if the thing type is deprecated.
 
         Requires permission to access the `DeprecateThingType <https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`_ action.
 
@@ -13078,7 +13084,7 @@ class CfnThingTypeProps:
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnThingType.ThingTypePropertiesProperty]]:
         '''The thing type properties for the thing type to create.
 
-        It contains information about the new thing type including a description, and a list of searchable thing attribute names. ``ThingTypeProperties`` can't be updated after the initial creation of the ``ThingType`` .
+        It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update ``Mqtt5Configuration`` .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.html#cfn-iot-thingtype-thingtypeproperties
         '''