aws-cdk-lib 2.132.1__py3-none-any.whl → 2.134.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +9 -1
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.132.1.jsii.tgz → aws-cdk-lib@2.134.0.jsii.tgz} +0 -0
- aws_cdk/aws_amplify/__init__.py +12 -10
- aws_cdk/aws_apigatewayv2/__init__.py +112 -6
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +155 -3
- aws_cdk/aws_appconfig/__init__.py +186 -8
- aws_cdk/aws_appintegrations/__init__.py +551 -0
- aws_cdk/aws_applicationautoscaling/__init__.py +6 -6
- aws_cdk/aws_appsync/__init__.py +71 -0
- aws_cdk/aws_autoscaling/__init__.py +10 -14
- aws_cdk/aws_b2bi/__init__.py +2 -42
- aws_cdk/aws_backup/__init__.py +23 -12
- aws_cdk/aws_batch/__init__.py +2150 -1078
- aws_cdk/aws_bedrock/__init__.py +197 -2
- aws_cdk/aws_cloudformation/__init__.py +1 -1
- aws_cdk/aws_cloudfront/__init__.py +4 -4
- aws_cdk/aws_cloudtrail/__init__.py +44 -14
- aws_cdk/aws_cloudwatch/__init__.py +20 -4
- aws_cdk/aws_codeartifact/__init__.py +812 -2
- aws_cdk/aws_codebuild/__init__.py +32 -10
- aws_cdk/aws_codepipeline/__init__.py +33 -11
- aws_cdk/aws_cognito/__init__.py +49 -44
- aws_cdk/aws_connect/__init__.py +256 -0
- aws_cdk/aws_controltower/__init__.py +4 -4
- aws_cdk/aws_datasync/__init__.py +393 -13
- aws_cdk/aws_dlm/__init__.py +2 -2
- aws_cdk/aws_docdbelastic/__init__.py +117 -0
- aws_cdk/aws_dynamodb/__init__.py +416 -5
- aws_cdk/aws_ec2/__init__.py +590 -134
- aws_cdk/aws_ecs/__init__.py +29 -20
- aws_cdk/aws_ecs_patterns/__init__.py +52 -12
- aws_cdk/aws_eks/__init__.py +27 -25
- aws_cdk/aws_elasticloadbalancing/__init__.py +6 -9
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +363 -62
- aws_cdk/aws_emr/__init__.py +7 -4
- aws_cdk/aws_entityresolution/__init__.py +91 -64
- aws_cdk/aws_fsx/__init__.py +7 -7
- aws_cdk/aws_glue/__init__.py +137 -3
- aws_cdk/aws_iam/__init__.py +9 -10
- aws_cdk/aws_internetmonitor/__init__.py +85 -0
- aws_cdk/aws_iotsitewise/__init__.py +208 -198
- aws_cdk/aws_iotwireless/__init__.py +6 -5
- aws_cdk/aws_kafkaconnect/__init__.py +1237 -162
- aws_cdk/aws_kendra/__init__.py +34 -24
- aws_cdk/aws_kinesisanalytics/__init__.py +37 -37
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +37 -37
- aws_cdk/aws_kinesisfirehose/__init__.py +6 -2
- aws_cdk/aws_lambda/__init__.py +16 -16
- aws_cdk/aws_msk/__init__.py +88 -0
- aws_cdk/aws_opensearchservice/__init__.py +61 -18
- aws_cdk/aws_pinpoint/__init__.py +42 -0
- aws_cdk/aws_rds/__init__.py +1292 -216
- aws_cdk/aws_redshift/__init__.py +6 -3
- aws_cdk/aws_redshiftserverless/__init__.py +0 -157
- aws_cdk/aws_sagemaker/__init__.py +29 -9
- aws_cdk/aws_shield/__init__.py +7 -8
- aws_cdk/aws_ssm/__init__.py +15 -12
- aws_cdk/aws_stepfunctions_tasks/__init__.py +476 -0
- aws_cdk/aws_synthetics/__init__.py +74 -14
- aws_cdk/aws_transfer/__init__.py +4 -3
- aws_cdk/aws_wafv2/__init__.py +516 -42
- aws_cdk/cx_api/__init__.py +34 -0
- {aws_cdk_lib-2.132.1.dist-info → aws_cdk_lib-2.134.0.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.132.1.dist-info → aws_cdk_lib-2.134.0.dist-info}/RECORD +69 -69
- {aws_cdk_lib-2.132.1.dist-info → aws_cdk_lib-2.134.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.132.1.dist-info → aws_cdk_lib-2.134.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.132.1.dist-info → aws_cdk_lib-2.134.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.132.1.dist-info → aws_cdk_lib-2.134.0.dist-info}/top_level.txt +0 -0
|
@@ -106,7 +106,7 @@ class CfnAccessPolicy(
|
|
|
106
106
|
:param scope: Scope in which this resource is defined.
|
|
107
107
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
108
108
|
:param access_policy_identity: The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
|
|
109
|
-
:param access_policy_permission: The permission level for this access policy.
|
|
109
|
+
:param access_policy_permission: The permission level for this access policy. Note that a project ``ADMINISTRATOR`` is also known as a project owner.
|
|
110
110
|
:param access_policy_resource: The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
|
|
111
111
|
'''
|
|
112
112
|
if __debug__:
|
|
@@ -242,7 +242,7 @@ class CfnAccessPolicy(
|
|
|
242
242
|
|
|
243
243
|
:param iam_role: An IAM role identity.
|
|
244
244
|
:param iam_user: An IAM user identity.
|
|
245
|
-
:param user:
|
|
245
|
+
:param user: An IAM Identity Center user identity.
|
|
246
246
|
|
|
247
247
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html
|
|
248
248
|
:exampleMetadata: fixture=_generated
|
|
@@ -304,7 +304,7 @@ class CfnAccessPolicy(
|
|
|
304
304
|
def user(
|
|
305
305
|
self,
|
|
306
306
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAccessPolicy.UserProperty"]]:
|
|
307
|
-
'''
|
|
307
|
+
'''An IAM Identity Center user identity.
|
|
308
308
|
|
|
309
309
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-user
|
|
310
310
|
'''
|
|
@@ -338,8 +338,8 @@ class CfnAccessPolicy(
|
|
|
338
338
|
|
|
339
339
|
Choose either a portal or a project.
|
|
340
340
|
|
|
341
|
-
:param portal:
|
|
342
|
-
:param project:
|
|
341
|
+
:param portal: Identifies an AWS IoT SiteWise Monitor portal.
|
|
342
|
+
:param project: Identifies a specific AWS IoT SiteWise Monitor project.
|
|
343
343
|
|
|
344
344
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html
|
|
345
345
|
:exampleMetadata: fixture=_generated
|
|
@@ -373,7 +373,7 @@ class CfnAccessPolicy(
|
|
|
373
373
|
def portal(
|
|
374
374
|
self,
|
|
375
375
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAccessPolicy.PortalProperty"]]:
|
|
376
|
-
'''
|
|
376
|
+
'''Identifies an AWS IoT SiteWise Monitor portal.
|
|
377
377
|
|
|
378
378
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-portal
|
|
379
379
|
'''
|
|
@@ -384,7 +384,7 @@ class CfnAccessPolicy(
|
|
|
384
384
|
def project(
|
|
385
385
|
self,
|
|
386
386
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAccessPolicy.ProjectProperty"]]:
|
|
387
|
-
'''
|
|
387
|
+
'''Identifies a specific AWS IoT SiteWise Monitor project.
|
|
388
388
|
|
|
389
389
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-project
|
|
390
390
|
'''
|
|
@@ -519,7 +519,7 @@ class CfnAccessPolicy(
|
|
|
519
519
|
)
|
|
520
520
|
class PortalProperty:
|
|
521
521
|
def __init__(self, *, id: typing.Optional[builtins.str] = None) -> None:
|
|
522
|
-
'''
|
|
522
|
+
'''Identifies an AWS IoT SiteWise Monitor portal.
|
|
523
523
|
|
|
524
524
|
:param id: The ID of the portal.
|
|
525
525
|
|
|
@@ -570,7 +570,7 @@ class CfnAccessPolicy(
|
|
|
570
570
|
)
|
|
571
571
|
class ProjectProperty:
|
|
572
572
|
def __init__(self, *, id: typing.Optional[builtins.str] = None) -> None:
|
|
573
|
-
'''
|
|
573
|
+
'''Identifies a specific AWS IoT SiteWise Monitor project.
|
|
574
574
|
|
|
575
575
|
:param id: The ID of the project.
|
|
576
576
|
|
|
@@ -621,9 +621,9 @@ class CfnAccessPolicy(
|
|
|
621
621
|
)
|
|
622
622
|
class UserProperty:
|
|
623
623
|
def __init__(self, *, id: typing.Optional[builtins.str] = None) -> None:
|
|
624
|
-
'''
|
|
624
|
+
'''Contains information for a user identity in an access policy.
|
|
625
625
|
|
|
626
|
-
:param id: The ID of the user.
|
|
626
|
+
:param id: The IAM Identity Center ID of the user.
|
|
627
627
|
|
|
628
628
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html
|
|
629
629
|
:exampleMetadata: fixture=_generated
|
|
@@ -647,7 +647,7 @@ class CfnAccessPolicy(
|
|
|
647
647
|
|
|
648
648
|
@builtins.property
|
|
649
649
|
def id(self) -> typing.Optional[builtins.str]:
|
|
650
|
-
'''The ID of the user.
|
|
650
|
+
'''The IAM Identity Center ID of the user.
|
|
651
651
|
|
|
652
652
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html#cfn-iotsitewise-accesspolicy-user-id
|
|
653
653
|
'''
|
|
@@ -686,7 +686,7 @@ class CfnAccessPolicyProps:
|
|
|
686
686
|
'''Properties for defining a ``CfnAccessPolicy``.
|
|
687
687
|
|
|
688
688
|
:param access_policy_identity: The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
|
|
689
|
-
:param access_policy_permission: The permission level for this access policy.
|
|
689
|
+
:param access_policy_permission: The permission level for this access policy. Note that a project ``ADMINISTRATOR`` is also known as a project owner.
|
|
690
690
|
:param access_policy_resource: The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
|
|
691
691
|
|
|
692
692
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html
|
|
@@ -750,7 +750,7 @@ class CfnAccessPolicyProps:
|
|
|
750
750
|
def access_policy_permission(self) -> builtins.str:
|
|
751
751
|
'''The permission level for this access policy.
|
|
752
752
|
|
|
753
|
-
|
|
753
|
+
Note that a project ``ADMINISTRATOR`` is also known as a project owner.
|
|
754
754
|
|
|
755
755
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicypermission
|
|
756
756
|
'''
|
|
@@ -851,10 +851,10 @@ class CfnAsset(
|
|
|
851
851
|
:param scope: Scope in which this resource is defined.
|
|
852
852
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
853
853
|
:param asset_model_id: The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
|
|
854
|
-
:param asset_name: A
|
|
855
|
-
:param asset_description:
|
|
856
|
-
:param asset_external_id: The
|
|
857
|
-
:param asset_hierarchies: A list of asset hierarchies that each contain a ``
|
|
854
|
+
:param asset_name: A friendly name for the asset.
|
|
855
|
+
:param asset_description: The ID of the asset, in UUID format.
|
|
856
|
+
:param asset_external_id: The external ID of the asset model composite model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
857
|
+
:param asset_hierarchies: A list of asset hierarchies that each contain a ``hierarchyId`` . A hierarchy specifies allowed parent/child asset relationships.
|
|
858
858
|
:param asset_properties: The list of asset properties for the asset. This object doesn't include properties that you define in composite models. You can find composite model properties in the ``assetCompositeModels`` object.
|
|
859
859
|
:param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
860
860
|
'''
|
|
@@ -949,7 +949,7 @@ class CfnAsset(
|
|
|
949
949
|
@builtins.property
|
|
950
950
|
@jsii.member(jsii_name="assetName")
|
|
951
951
|
def asset_name(self) -> builtins.str:
|
|
952
|
-
'''A
|
|
952
|
+
'''A friendly name for the asset.'''
|
|
953
953
|
return typing.cast(builtins.str, jsii.get(self, "assetName"))
|
|
954
954
|
|
|
955
955
|
@asset_name.setter
|
|
@@ -962,7 +962,7 @@ class CfnAsset(
|
|
|
962
962
|
@builtins.property
|
|
963
963
|
@jsii.member(jsii_name="assetDescription")
|
|
964
964
|
def asset_description(self) -> typing.Optional[builtins.str]:
|
|
965
|
-
'''
|
|
965
|
+
'''The ID of the asset, in UUID format.'''
|
|
966
966
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "assetDescription"))
|
|
967
967
|
|
|
968
968
|
@asset_description.setter
|
|
@@ -975,7 +975,7 @@ class CfnAsset(
|
|
|
975
975
|
@builtins.property
|
|
976
976
|
@jsii.member(jsii_name="assetExternalId")
|
|
977
977
|
def asset_external_id(self) -> typing.Optional[builtins.str]:
|
|
978
|
-
'''The
|
|
978
|
+
'''The external ID of the asset model composite model.'''
|
|
979
979
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "assetExternalId"))
|
|
980
980
|
|
|
981
981
|
@asset_external_id.setter
|
|
@@ -990,7 +990,7 @@ class CfnAsset(
|
|
|
990
990
|
def asset_hierarchies(
|
|
991
991
|
self,
|
|
992
992
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAsset.AssetHierarchyProperty"]]]]:
|
|
993
|
-
'''A list of asset hierarchies that each contain a ``
|
|
993
|
+
'''A list of asset hierarchies that each contain a ``hierarchyId`` .'''
|
|
994
994
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAsset.AssetHierarchyProperty"]]]], jsii.get(self, "assetHierarchies"))
|
|
995
995
|
|
|
996
996
|
@asset_hierarchies.setter
|
|
@@ -1053,12 +1053,12 @@ class CfnAsset(
|
|
|
1053
1053
|
id: typing.Optional[builtins.str] = None,
|
|
1054
1054
|
logical_id: typing.Optional[builtins.str] = None,
|
|
1055
1055
|
) -> None:
|
|
1056
|
-
'''Describes an asset hierarchy that contains a
|
|
1056
|
+
'''Describes an asset hierarchy that contains a hierarchy's name and ID.
|
|
1057
1057
|
|
|
1058
1058
|
:param child_asset_id: The Id of the child asset.
|
|
1059
|
-
:param external_id:
|
|
1060
|
-
:param id:
|
|
1061
|
-
:param logical_id: The
|
|
1059
|
+
:param external_id: The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1060
|
+
:param id: The ID of the hierarchy. This ID is a ``hierarchyId`` . .. epigraph:: This is a return value and can't be set.
|
|
1061
|
+
:param logical_id: The ID of the hierarchy. This ID is a ``hierarchyId`` .
|
|
1062
1062
|
|
|
1063
1063
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html
|
|
1064
1064
|
:exampleMetadata: fixture=_generated
|
|
@@ -1106,7 +1106,9 @@ class CfnAsset(
|
|
|
1106
1106
|
|
|
1107
1107
|
@builtins.property
|
|
1108
1108
|
def external_id(self) -> typing.Optional[builtins.str]:
|
|
1109
|
-
'''
|
|
1109
|
+
'''The external ID of the hierarchy, if it has one.
|
|
1110
|
+
|
|
1111
|
+
When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1110
1112
|
|
|
1111
1113
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-externalid
|
|
1112
1114
|
'''
|
|
@@ -1115,7 +1117,11 @@ class CfnAsset(
|
|
|
1115
1117
|
|
|
1116
1118
|
@builtins.property
|
|
1117
1119
|
def id(self) -> typing.Optional[builtins.str]:
|
|
1118
|
-
'''
|
|
1120
|
+
'''The ID of the hierarchy. This ID is a ``hierarchyId`` .
|
|
1121
|
+
|
|
1122
|
+
.. epigraph::
|
|
1123
|
+
|
|
1124
|
+
This is a return value and can't be set.
|
|
1119
1125
|
|
|
1120
1126
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-id
|
|
1121
1127
|
'''
|
|
@@ -1124,9 +1130,9 @@ class CfnAsset(
|
|
|
1124
1130
|
|
|
1125
1131
|
@builtins.property
|
|
1126
1132
|
def logical_id(self) -> typing.Optional[builtins.str]:
|
|
1127
|
-
'''The
|
|
1133
|
+
'''The ID of the hierarchy.
|
|
1128
1134
|
|
|
1129
|
-
|
|
1135
|
+
This ID is a ``hierarchyId`` .
|
|
1130
1136
|
|
|
1131
1137
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-logicalid
|
|
1132
1138
|
'''
|
|
@@ -1169,11 +1175,11 @@ class CfnAsset(
|
|
|
1169
1175
|
) -> None:
|
|
1170
1176
|
'''Contains asset property information.
|
|
1171
1177
|
|
|
1172
|
-
:param alias: The
|
|
1173
|
-
:param external_id:
|
|
1174
|
-
:param id:
|
|
1175
|
-
:param logical_id: The ``LogicalID`` of the asset property.
|
|
1176
|
-
:param notification_state: The MQTT notification state (
|
|
1178
|
+
:param alias: The alias that identifies the property, such as an OPC-UA server data stream path (for example, ``/company/windfarm/3/turbine/7/temperature`` ). For more information, see `Mapping industrial data streams to asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1179
|
+
:param external_id: The external ID of the property. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1180
|
+
:param id: The ID of the asset property. .. epigraph:: This is a return value and can't be set.
|
|
1181
|
+
:param logical_id: The ``LogicalID`` of the asset property.
|
|
1182
|
+
:param notification_state: The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see `Interacting with other services <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html>`_ in the *AWS IoT SiteWise User Guide* . If you omit this parameter, the notification state is set to ``DISABLED`` .
|
|
1177
1183
|
:param unit: The unit (such as ``Newtons`` or ``RPM`` ) of the asset property.
|
|
1178
1184
|
|
|
1179
1185
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html
|
|
@@ -1218,12 +1224,10 @@ class CfnAsset(
|
|
|
1218
1224
|
|
|
1219
1225
|
@builtins.property
|
|
1220
1226
|
def alias(self) -> typing.Optional[builtins.str]:
|
|
1221
|
-
'''The
|
|
1227
|
+
'''The alias that identifies the property, such as an OPC-UA server data stream path (for example, ``/company/windfarm/3/turbine/7/temperature`` ).
|
|
1222
1228
|
|
|
1223
1229
|
For more information, see `Mapping industrial data streams to asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1224
1230
|
|
|
1225
|
-
The property alias must have 1-1000 characters.
|
|
1226
|
-
|
|
1227
1231
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-alias
|
|
1228
1232
|
'''
|
|
1229
1233
|
result = self._values.get("alias")
|
|
@@ -1231,7 +1235,9 @@ class CfnAsset(
|
|
|
1231
1235
|
|
|
1232
1236
|
@builtins.property
|
|
1233
1237
|
def external_id(self) -> typing.Optional[builtins.str]:
|
|
1234
|
-
'''
|
|
1238
|
+
'''The external ID of the property.
|
|
1239
|
+
|
|
1240
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1235
1241
|
|
|
1236
1242
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-externalid
|
|
1237
1243
|
'''
|
|
@@ -1240,7 +1246,11 @@ class CfnAsset(
|
|
|
1240
1246
|
|
|
1241
1247
|
@builtins.property
|
|
1242
1248
|
def id(self) -> typing.Optional[builtins.str]:
|
|
1243
|
-
'''
|
|
1249
|
+
'''The ID of the asset property.
|
|
1250
|
+
|
|
1251
|
+
.. epigraph::
|
|
1252
|
+
|
|
1253
|
+
This is a return value and can't be set.
|
|
1244
1254
|
|
|
1245
1255
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-id
|
|
1246
1256
|
'''
|
|
@@ -1251,8 +1261,6 @@ class CfnAsset(
|
|
|
1251
1261
|
def logical_id(self) -> typing.Optional[builtins.str]:
|
|
1252
1262
|
'''The ``LogicalID`` of the asset property.
|
|
1253
1263
|
|
|
1254
|
-
The maximum length is 256 characters, with the pattern ``[^\\u0000-\\u001F\\u007F]+`` .
|
|
1255
|
-
|
|
1256
1264
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-logicalid
|
|
1257
1265
|
'''
|
|
1258
1266
|
result = self._values.get("logical_id")
|
|
@@ -1260,14 +1268,11 @@ class CfnAsset(
|
|
|
1260
1268
|
|
|
1261
1269
|
@builtins.property
|
|
1262
1270
|
def notification_state(self) -> typing.Optional[builtins.str]:
|
|
1263
|
-
'''The MQTT notification state (
|
|
1271
|
+
'''The MQTT notification state (enabled or disabled) for this asset property.
|
|
1264
1272
|
|
|
1265
|
-
When the notification state is
|
|
1273
|
+
When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see `Interacting with other services <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1266
1274
|
|
|
1267
1275
|
If you omit this parameter, the notification state is set to ``DISABLED`` .
|
|
1268
|
-
.. epigraph::
|
|
1269
|
-
|
|
1270
|
-
You must use all caps for the NotificationState parameter. If you use lower case letters, you will receive a schema validation error.
|
|
1271
1276
|
|
|
1272
1277
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-notificationstate
|
|
1273
1278
|
'''
|
|
@@ -1305,6 +1310,11 @@ class CfnAssetModel(
|
|
|
1305
1310
|
|
|
1306
1311
|
You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see `Defining asset models <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1307
1312
|
|
|
1313
|
+
You can create two types of asset models, ``ASSET_MODEL`` or ``COMPONENT_MODEL`` .
|
|
1314
|
+
|
|
1315
|
+
- *ASSET_MODEL* – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
|
|
1316
|
+
- *COMPONENT_MODEL* – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
|
|
1317
|
+
|
|
1308
1318
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html
|
|
1309
1319
|
:cloudformationResource: AWS::IoTSiteWise::AssetModel
|
|
1310
1320
|
:exampleMetadata: fixture=_generated
|
|
@@ -1489,13 +1499,13 @@ class CfnAssetModel(
|
|
|
1489
1499
|
'''
|
|
1490
1500
|
:param scope: Scope in which this resource is defined.
|
|
1491
1501
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
1492
|
-
:param asset_model_name: A unique, friendly name for the asset model.
|
|
1493
|
-
:param asset_model_composite_models: The composite
|
|
1502
|
+
:param asset_model_name: A unique, friendly name for the asset model.
|
|
1503
|
+
:param asset_model_composite_models: The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. .. epigraph:: When creating custom composite models, you need to use `CreateAssetModelCompositeModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html>`_ . For more information, see `Creating custom composite models (Components) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1494
1504
|
:param asset_model_description: A description for the asset model.
|
|
1495
|
-
:param asset_model_external_id: The external ID of the asset model.
|
|
1496
|
-
:param asset_model_hierarchies: The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see `
|
|
1497
|
-
:param asset_model_properties: The property definitions of the asset model. For more information, see `
|
|
1498
|
-
:param asset_model_type: The type of
|
|
1505
|
+
:param asset_model_external_id: The external ID of the asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1506
|
+
:param asset_model_hierarchies: The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 10 hierarchies per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1507
|
+
:param asset_model_properties: The property definitions of the asset model. For more information, see `Asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 200 properties per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1508
|
+
:param asset_model_type: The type of asset model. - *ASSET_MODEL* – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. - *COMPONENT_MODEL* – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
|
|
1499
1509
|
:param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1500
1510
|
'''
|
|
1501
1511
|
if __debug__:
|
|
@@ -1592,7 +1602,7 @@ class CfnAssetModel(
|
|
|
1592
1602
|
def asset_model_composite_models(
|
|
1593
1603
|
self,
|
|
1594
1604
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAssetModel.AssetModelCompositeModelProperty"]]]]:
|
|
1595
|
-
'''The composite
|
|
1605
|
+
'''The composite models that are part of this asset model.'''
|
|
1596
1606
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAssetModel.AssetModelCompositeModelProperty"]]]], jsii.get(self, "assetModelCompositeModels"))
|
|
1597
1607
|
|
|
1598
1608
|
@asset_model_composite_models.setter
|
|
@@ -1670,7 +1680,7 @@ class CfnAssetModel(
|
|
|
1670
1680
|
@builtins.property
|
|
1671
1681
|
@jsii.member(jsii_name="assetModelType")
|
|
1672
1682
|
def asset_model_type(self) -> typing.Optional[builtins.str]:
|
|
1673
|
-
'''The type of
|
|
1683
|
+
'''The type of asset model.'''
|
|
1674
1684
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "assetModelType"))
|
|
1675
1685
|
|
|
1676
1686
|
@asset_model_type.setter
|
|
@@ -1724,46 +1734,17 @@ class CfnAssetModel(
|
|
|
1724
1734
|
) -> None:
|
|
1725
1735
|
'''Contains information about a composite model in an asset model.
|
|
1726
1736
|
|
|
1727
|
-
This object contains the asset property definitions that you define in the composite model.
|
|
1728
|
-
|
|
1729
|
-
If you use the ``AssetModelCompositeModel`` property to create an alarm, you must use the following information to define three asset model properties:
|
|
1730
|
-
|
|
1731
|
-
- Use an asset model property to specify the alarm type.
|
|
1732
|
-
- The name must be ``AWS/ALARM_TYPE`` .
|
|
1733
|
-
- The data type must be ``STRING`` .
|
|
1734
|
-
- For the ``Type`` property, the type name must be ``Attribute`` and the default value must be ``IOT_EVENTS`` .
|
|
1735
|
-
- Use an asset model property to specify the alarm source.
|
|
1736
|
-
- The name must be ``AWS/ALARM_SOURCE`` .
|
|
1737
|
-
- The data type must be ``STRING`` .
|
|
1738
|
-
- For the ``Type`` property, the type name must be ``Attribute`` and the default value must be the ARN of the alarm model that you created in AWS IoT Events .
|
|
1739
|
-
|
|
1740
|
-
.. epigraph::
|
|
1741
|
-
|
|
1742
|
-
For the ARN of the alarm model, you can use the ``Fn::Sub`` intrinsic function to substitute the ``AWS::Partition`` , ``AWS::Region`` , and ``AWS::AccountId`` variables in an input string with values that you specify.
|
|
1743
|
-
|
|
1744
|
-
For example, ``Fn::Sub: "arn:${AWS::Partition}:iotevents:${AWS::Region}:${AWS::AccountId}:alarmModel/TestAlarmModel"`` .
|
|
1745
|
-
|
|
1746
|
-
Replace ``TestAlarmModel`` with the name of your alarm model.
|
|
1747
|
-
|
|
1748
|
-
For more information about using the ``Fn::Sub`` intrinsic function, see `Fn::Sub <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-sub.html>`_ .
|
|
1749
|
-
|
|
1750
|
-
- Use an asset model property to specify the state of the alarm.
|
|
1751
|
-
- The name must be ``AWS/ALARM_STATE`` .
|
|
1752
|
-
- The data type must be ``STRUCT`` .
|
|
1753
|
-
- The ``DataTypeSpec`` value must be ``AWS/ALARM_STATE`` .
|
|
1754
|
-
- For the ``Type`` property, the type name must be ``Measurement`` .
|
|
1755
|
-
|
|
1756
|
-
At the bottom of this page, we provide a YAML example that you can modify to create an alarm.
|
|
1737
|
+
This object contains the asset property definitions that you define in the composite model.
|
|
1757
1738
|
|
|
1758
1739
|
:param name: The name of the composite model.
|
|
1759
1740
|
:param type: The type of the composite model. For alarm composite models, this type is ``AWS/ALARM`` .
|
|
1760
|
-
:param composed_asset_model_id: The component model
|
|
1741
|
+
:param composed_asset_model_id: The ID of a component model which is reused to create this composite model.
|
|
1761
1742
|
:param composite_model_properties: The asset property definitions for this composite model.
|
|
1762
1743
|
:param description: The description of the composite model.
|
|
1763
|
-
:param external_id: The
|
|
1764
|
-
:param id: The
|
|
1765
|
-
:param parent_asset_model_composite_model_external_id: The parent
|
|
1766
|
-
:param path: The path of the
|
|
1744
|
+
:param external_id: The external ID of a composite model on this asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1745
|
+
:param id: The ID of the asset model composite model. .. epigraph:: This is a return value and can't be set.
|
|
1746
|
+
:param parent_asset_model_composite_model_external_id: The external ID of the parent asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . .. epigraph:: If ``ParentCompositeModelExternalId`` is specified, this value overrides the value of ``ExternalId`` , if both are included.
|
|
1747
|
+
:param path: The structured path to the property from the root of the asset using property names. Path is used as the ID if the asset model is a derived composite model.
|
|
1767
1748
|
|
|
1768
1749
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html
|
|
1769
1750
|
:exampleMetadata: fixture=_generated
|
|
@@ -1902,7 +1883,7 @@ class CfnAssetModel(
|
|
|
1902
1883
|
|
|
1903
1884
|
@builtins.property
|
|
1904
1885
|
def composed_asset_model_id(self) -> typing.Optional[builtins.str]:
|
|
1905
|
-
'''The component model
|
|
1886
|
+
'''The ID of a component model which is reused to create this composite model.
|
|
1906
1887
|
|
|
1907
1888
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-composedassetmodelid
|
|
1908
1889
|
'''
|
|
@@ -1931,7 +1912,9 @@ class CfnAssetModel(
|
|
|
1931
1912
|
|
|
1932
1913
|
@builtins.property
|
|
1933
1914
|
def external_id(self) -> typing.Optional[builtins.str]:
|
|
1934
|
-
'''The
|
|
1915
|
+
'''The external ID of a composite model on this asset model.
|
|
1916
|
+
|
|
1917
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1935
1918
|
|
|
1936
1919
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-externalid
|
|
1937
1920
|
'''
|
|
@@ -1940,7 +1923,11 @@ class CfnAssetModel(
|
|
|
1940
1923
|
|
|
1941
1924
|
@builtins.property
|
|
1942
1925
|
def id(self) -> typing.Optional[builtins.str]:
|
|
1943
|
-
'''The
|
|
1926
|
+
'''The ID of the asset model composite model.
|
|
1927
|
+
|
|
1928
|
+
.. epigraph::
|
|
1929
|
+
|
|
1930
|
+
This is a return value and can't be set.
|
|
1944
1931
|
|
|
1945
1932
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-id
|
|
1946
1933
|
'''
|
|
@@ -1951,7 +1938,12 @@ class CfnAssetModel(
|
|
|
1951
1938
|
def parent_asset_model_composite_model_external_id(
|
|
1952
1939
|
self,
|
|
1953
1940
|
) -> typing.Optional[builtins.str]:
|
|
1954
|
-
'''The parent
|
|
1941
|
+
'''The external ID of the parent asset model.
|
|
1942
|
+
|
|
1943
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1944
|
+
.. epigraph::
|
|
1945
|
+
|
|
1946
|
+
If ``ParentCompositeModelExternalId`` is specified, this value overrides the value of ``ExternalId`` , if both are included.
|
|
1955
1947
|
|
|
1956
1948
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-parentassetmodelcompositemodelexternalid
|
|
1957
1949
|
'''
|
|
@@ -1960,9 +1952,9 @@ class CfnAssetModel(
|
|
|
1960
1952
|
|
|
1961
1953
|
@builtins.property
|
|
1962
1954
|
def path(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1963
|
-
'''The path of the
|
|
1955
|
+
'''The structured path to the property from the root of the asset using property names.
|
|
1964
1956
|
|
|
1965
|
-
|
|
1957
|
+
Path is used as the ID if the asset model is a derived composite model.
|
|
1966
1958
|
|
|
1967
1959
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-path
|
|
1968
1960
|
'''
|
|
@@ -2001,13 +1993,13 @@ class CfnAssetModel(
|
|
|
2001
1993
|
id: typing.Optional[builtins.str] = None,
|
|
2002
1994
|
logical_id: typing.Optional[builtins.str] = None,
|
|
2003
1995
|
) -> None:
|
|
2004
|
-
'''Describes an asset hierarchy that contains a hierarchy's name,
|
|
1996
|
+
'''Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
|
|
2005
1997
|
|
|
2006
|
-
:param child_asset_model_id: The
|
|
2007
|
-
:param name: The name of the asset model hierarchy
|
|
2008
|
-
:param external_id:
|
|
2009
|
-
:param id:
|
|
2010
|
-
:param logical_id: The ``LogicalID`` of the asset model hierarchy. This ID is a ``hierarchyLogicalId`` .
|
|
1998
|
+
:param child_asset_model_id: The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the ``childAssetModelId`` asset model. AWS IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ , you may provide either the asset model ID or else ``externalId:`` followed by the asset model's external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
1999
|
+
:param name: The name of the asset model hierarchy that you specify by using the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`_ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ API operation.
|
|
2000
|
+
:param external_id: The external ID (if any) provided in the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`_ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ operation. You can assign an external ID by specifying this value as part of a call to `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ . However, you can't change the external ID if one is already assigned. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2001
|
+
:param id: The ID of the asset model hierarchy. This ID is a ``hierarchyId`` . .. epigraph:: This is a return value and can't be set. - If you are callling `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ to create a *new* hierarchy: You can specify its ID here, if desired. AWS IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. - If you are calling UpdateAssetModel to modify an *existing* hierarchy: This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2002
|
+
:param logical_id: The ``LogicalID`` of the asset model hierarchy. This ID is a ``hierarchyLogicalId`` .
|
|
2011
2003
|
|
|
2012
2004
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html
|
|
2013
2005
|
:exampleMetadata: fixture=_generated
|
|
@@ -2048,7 +2040,9 @@ class CfnAssetModel(
|
|
|
2048
2040
|
|
|
2049
2041
|
@builtins.property
|
|
2050
2042
|
def child_asset_model_id(self) -> builtins.str:
|
|
2051
|
-
'''The
|
|
2043
|
+
'''The ID of the asset model, in UUID format.
|
|
2044
|
+
|
|
2045
|
+
All assets in this hierarchy must be instances of the ``childAssetModelId`` asset model. AWS IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ , you may provide either the asset model ID or else ``externalId:`` followed by the asset model's external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2052
2046
|
|
|
2053
2047
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-childassetmodelid
|
|
2054
2048
|
'''
|
|
@@ -2058,9 +2052,7 @@ class CfnAssetModel(
|
|
|
2058
2052
|
|
|
2059
2053
|
@builtins.property
|
|
2060
2054
|
def name(self) -> builtins.str:
|
|
2061
|
-
'''The name of the asset model hierarchy.
|
|
2062
|
-
|
|
2063
|
-
The maximum length is 256 characters with the pattern ``[^\\u0000-\\u001F\\u007F]+`` .
|
|
2055
|
+
'''The name of the asset model hierarchy that you specify by using the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`_ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ API operation.
|
|
2064
2056
|
|
|
2065
2057
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-name
|
|
2066
2058
|
'''
|
|
@@ -2070,7 +2062,7 @@ class CfnAssetModel(
|
|
|
2070
2062
|
|
|
2071
2063
|
@builtins.property
|
|
2072
2064
|
def external_id(self) -> typing.Optional[builtins.str]:
|
|
2073
|
-
'''
|
|
2065
|
+
'''The external ID (if any) provided in the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`_ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ operation. You can assign an external ID by specifying this value as part of a call to `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ . However, you can't change the external ID if one is already assigned. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2074
2066
|
|
|
2075
2067
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-externalid
|
|
2076
2068
|
'''
|
|
@@ -2079,7 +2071,14 @@ class CfnAssetModel(
|
|
|
2079
2071
|
|
|
2080
2072
|
@builtins.property
|
|
2081
2073
|
def id(self) -> typing.Optional[builtins.str]:
|
|
2082
|
-
'''
|
|
2074
|
+
'''The ID of the asset model hierarchy. This ID is a ``hierarchyId`` .
|
|
2075
|
+
|
|
2076
|
+
.. epigraph::
|
|
2077
|
+
|
|
2078
|
+
This is a return value and can't be set.
|
|
2079
|
+
|
|
2080
|
+
- If you are callling `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ to create a *new* hierarchy: You can specify its ID here, if desired. AWS IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
|
|
2081
|
+
- If you are calling UpdateAssetModel to modify an *existing* hierarchy: This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2083
2082
|
|
|
2084
2083
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-id
|
|
2085
2084
|
'''
|
|
@@ -2088,9 +2087,9 @@ class CfnAssetModel(
|
|
|
2088
2087
|
|
|
2089
2088
|
@builtins.property
|
|
2090
2089
|
def logical_id(self) -> typing.Optional[builtins.str]:
|
|
2091
|
-
'''The ``LogicalID`` of the asset model hierarchy.
|
|
2090
|
+
'''The ``LogicalID`` of the asset model hierarchy.
|
|
2092
2091
|
|
|
2093
|
-
|
|
2092
|
+
This ID is a ``hierarchyLogicalId`` .
|
|
2094
2093
|
|
|
2095
2094
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-logicalid
|
|
2096
2095
|
'''
|
|
@@ -2137,13 +2136,13 @@ class CfnAssetModel(
|
|
|
2137
2136
|
) -> None:
|
|
2138
2137
|
'''Contains information about an asset model property.
|
|
2139
2138
|
|
|
2140
|
-
:param data_type: The data type of the asset model property.
|
|
2141
|
-
:param name: The name of the asset model property.
|
|
2142
|
-
:param type: Contains a property type, which can be one of ``
|
|
2139
|
+
:param data_type: The data type of the asset model property.
|
|
2140
|
+
:param name: The name of the asset model property.
|
|
2141
|
+
:param type: Contains a property type, which can be one of ``attribute`` , ``measurement`` , ``metric`` , or ``transform`` .
|
|
2143
2142
|
:param data_type_spec: The data type of the structure for this property. This parameter exists on properties that have the ``STRUCT`` data type.
|
|
2144
|
-
:param external_id: The
|
|
2145
|
-
:param id: The ID of the
|
|
2146
|
-
:param logical_id: The ``LogicalID`` of the asset model property.
|
|
2143
|
+
:param external_id: The external ID of the asset property. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2144
|
+
:param id: The ID of the property. .. epigraph:: This is a return value and can't be set.
|
|
2145
|
+
:param logical_id: The ``LogicalID`` of the asset model property.
|
|
2147
2146
|
:param unit: The unit of the asset model property, such as ``Newtons`` or ``RPM`` .
|
|
2148
2147
|
|
|
2149
2148
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html
|
|
@@ -2247,8 +2246,6 @@ class CfnAssetModel(
|
|
|
2247
2246
|
def data_type(self) -> builtins.str:
|
|
2248
2247
|
'''The data type of the asset model property.
|
|
2249
2248
|
|
|
2250
|
-
The value can be ``STRING`` , ``INTEGER`` , ``DOUBLE`` , ``BOOLEAN`` , or ``STRUCT`` .
|
|
2251
|
-
|
|
2252
2249
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatype
|
|
2253
2250
|
'''
|
|
2254
2251
|
result = self._values.get("data_type")
|
|
@@ -2259,8 +2256,6 @@ class CfnAssetModel(
|
|
|
2259
2256
|
def name(self) -> builtins.str:
|
|
2260
2257
|
'''The name of the asset model property.
|
|
2261
2258
|
|
|
2262
|
-
The maximum length is 256 characters with the pattern ``[^\\u0000-\\u001F\\u007F]+`` .
|
|
2263
|
-
|
|
2264
2259
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-name
|
|
2265
2260
|
'''
|
|
2266
2261
|
result = self._values.get("name")
|
|
@@ -2271,7 +2266,7 @@ class CfnAssetModel(
|
|
|
2271
2266
|
def type(
|
|
2272
2267
|
self,
|
|
2273
2268
|
) -> typing.Union[_IResolvable_da3f097b, "CfnAssetModel.PropertyTypeProperty"]:
|
|
2274
|
-
'''Contains a property type, which can be one of ``
|
|
2269
|
+
'''Contains a property type, which can be one of ``attribute`` , ``measurement`` , ``metric`` , or ``transform`` .
|
|
2275
2270
|
|
|
2276
2271
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-type
|
|
2277
2272
|
'''
|
|
@@ -2292,7 +2287,9 @@ class CfnAssetModel(
|
|
|
2292
2287
|
|
|
2293
2288
|
@builtins.property
|
|
2294
2289
|
def external_id(self) -> typing.Optional[builtins.str]:
|
|
2295
|
-
'''The
|
|
2290
|
+
'''The external ID of the asset property.
|
|
2291
|
+
|
|
2292
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2296
2293
|
|
|
2297
2294
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-externalid
|
|
2298
2295
|
'''
|
|
@@ -2301,7 +2298,11 @@ class CfnAssetModel(
|
|
|
2301
2298
|
|
|
2302
2299
|
@builtins.property
|
|
2303
2300
|
def id(self) -> typing.Optional[builtins.str]:
|
|
2304
|
-
'''The ID of the
|
|
2301
|
+
'''The ID of the property.
|
|
2302
|
+
|
|
2303
|
+
.. epigraph::
|
|
2304
|
+
|
|
2305
|
+
This is a return value and can't be set.
|
|
2305
2306
|
|
|
2306
2307
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-id
|
|
2307
2308
|
'''
|
|
@@ -2312,8 +2313,6 @@ class CfnAssetModel(
|
|
|
2312
2313
|
def logical_id(self) -> typing.Optional[builtins.str]:
|
|
2313
2314
|
'''The ``LogicalID`` of the asset model property.
|
|
2314
2315
|
|
|
2315
|
-
The maximum length is 256 characters, with the pattern ``[^\\\\u0000-\\\\u001F\\\\u007F]+`` .
|
|
2316
|
-
|
|
2317
2316
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-logicalid
|
|
2318
2317
|
'''
|
|
2319
2318
|
result = self._values.get("logical_id")
|
|
@@ -2352,7 +2351,7 @@ class CfnAssetModel(
|
|
|
2352
2351
|
) -> None:
|
|
2353
2352
|
'''Contains an asset attribute property.
|
|
2354
2353
|
|
|
2355
|
-
For more information, see `
|
|
2354
|
+
For more information, see `Attributes <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2356
2355
|
|
|
2357
2356
|
:param default_value: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see `Updating attribute values <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2358
2357
|
|
|
@@ -2412,7 +2411,7 @@ class CfnAssetModel(
|
|
|
2412
2411
|
) -> None:
|
|
2413
2412
|
'''Contains expression variable information.
|
|
2414
2413
|
|
|
2415
|
-
:param name: The friendly name of the variable to be used in the expression.
|
|
2414
|
+
:param name: The friendly name of the variable to be used in the expression.
|
|
2416
2415
|
:param value: The variable that identifies an asset property from which to use values.
|
|
2417
2416
|
|
|
2418
2417
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html
|
|
@@ -2452,8 +2451,6 @@ class CfnAssetModel(
|
|
|
2452
2451
|
def name(self) -> builtins.str:
|
|
2453
2452
|
'''The friendly name of the variable to be used in the expression.
|
|
2454
2453
|
|
|
2455
|
-
The maximum length is 64 characters with the pattern ``^[a-z][a-z0-9_]*$`` .
|
|
2456
|
-
|
|
2457
2454
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-expressionvariable.html#cfn-iotsitewise-assetmodel-expressionvariable-name
|
|
2458
2455
|
'''
|
|
2459
2456
|
result = self._values.get("name")
|
|
@@ -2506,7 +2503,7 @@ class CfnAssetModel(
|
|
|
2506
2503
|
|
|
2507
2504
|
The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a *root* metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of ``DOUBLE`` and consume properties with data types of ``INTEGER`` or ``DOUBLE`` .
|
|
2508
2505
|
|
|
2509
|
-
For more information, see `
|
|
2506
|
+
For more information, see `Metrics <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2510
2507
|
|
|
2511
2508
|
:param expression: The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2512
2509
|
:param variables: The list of variables used in the expression.
|
|
@@ -2678,9 +2675,9 @@ class CfnAssetModel(
|
|
|
2678
2675
|
)
|
|
2679
2676
|
class PropertyPathDefinitionProperty:
|
|
2680
2677
|
def __init__(self, *, name: builtins.str) -> None:
|
|
2681
|
-
'''
|
|
2678
|
+
'''Represents one level between a composite model and the root of the asset model.
|
|
2682
2679
|
|
|
2683
|
-
:param name: The name of the
|
|
2680
|
+
:param name: The name of the path segment.
|
|
2684
2681
|
|
|
2685
2682
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html
|
|
2686
2683
|
:exampleMetadata: fixture=_generated
|
|
@@ -2704,7 +2701,7 @@ class CfnAssetModel(
|
|
|
2704
2701
|
|
|
2705
2702
|
@builtins.property
|
|
2706
2703
|
def name(self) -> builtins.str:
|
|
2707
|
-
'''The name of the
|
|
2704
|
+
'''The name of the path segment.
|
|
2708
2705
|
|
|
2709
2706
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html#cfn-iotsitewise-assetmodel-propertypathdefinition-name
|
|
2710
2707
|
'''
|
|
@@ -2742,12 +2739,12 @@ class CfnAssetModel(
|
|
|
2742
2739
|
metric: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAssetModel.MetricProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2743
2740
|
transform: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAssetModel.TransformProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2744
2741
|
) -> None:
|
|
2745
|
-
'''Contains a property type, which can be one of ``
|
|
2742
|
+
'''Contains a property type, which can be one of ``attribute`` , ``measurement`` , ``metric`` , or ``transform`` .
|
|
2746
2743
|
|
|
2747
2744
|
:param type_name: The type of property type, which can be one of ``Attribute`` , ``Measurement`` , ``Metric`` , or ``Transform`` .
|
|
2748
|
-
:param attribute: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an `
|
|
2749
|
-
:param metric: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
|
|
2750
|
-
:param transform: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
|
|
2745
|
+
:param attribute: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an `IIoT <https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications>`_ wind turbine.
|
|
2746
|
+
:param metric: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
|
|
2747
|
+
:param transform: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
|
|
2751
2748
|
|
|
2752
2749
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html
|
|
2753
2750
|
:exampleMetadata: fixture=_generated
|
|
@@ -2841,9 +2838,7 @@ class CfnAssetModel(
|
|
|
2841
2838
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAssetModel.AttributeProperty"]]:
|
|
2842
2839
|
'''Specifies an asset attribute property.
|
|
2843
2840
|
|
|
2844
|
-
An attribute generally contains static information, such as the serial number of an `
|
|
2845
|
-
|
|
2846
|
-
This is required if the ``TypeName`` is ``Attribute`` and has a ``DefaultValue`` .
|
|
2841
|
+
An attribute generally contains static information, such as the serial number of an `IIoT <https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications>`_ wind turbine.
|
|
2847
2842
|
|
|
2848
2843
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-attribute
|
|
2849
2844
|
'''
|
|
@@ -2858,8 +2853,6 @@ class CfnAssetModel(
|
|
|
2858
2853
|
|
|
2859
2854
|
A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
|
|
2860
2855
|
|
|
2861
|
-
This is required if the ``TypeName`` is ``Metric`` .
|
|
2862
|
-
|
|
2863
2856
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-metric
|
|
2864
2857
|
'''
|
|
2865
2858
|
result = self._values.get("metric")
|
|
@@ -2873,8 +2866,6 @@ class CfnAssetModel(
|
|
|
2873
2866
|
|
|
2874
2867
|
A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
|
|
2875
2868
|
|
|
2876
|
-
This is required if the ``TypeName`` is ``Transform`` .
|
|
2877
|
-
|
|
2878
2869
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html#cfn-iotsitewise-assetmodel-propertytype-transform
|
|
2879
2870
|
'''
|
|
2880
2871
|
result = self._values.get("transform")
|
|
@@ -2905,9 +2896,9 @@ class CfnAssetModel(
|
|
|
2905
2896
|
) -> None:
|
|
2906
2897
|
'''Contains an asset transform property.
|
|
2907
2898
|
|
|
2908
|
-
A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream.
|
|
2899
|
+
A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of ``DOUBLE`` and consume properties with data types of ``INTEGER`` or ``DOUBLE`` .
|
|
2909
2900
|
|
|
2910
|
-
For more information, see `
|
|
2901
|
+
For more information, see `Transforms <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2911
2902
|
|
|
2912
2903
|
:param expression: The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
2913
2904
|
:param variables: The list of variables used in the expression.
|
|
@@ -3118,13 +3109,13 @@ class CfnAssetModel(
|
|
|
3118
3109
|
) -> None:
|
|
3119
3110
|
'''Identifies a property value used in an expression.
|
|
3120
3111
|
|
|
3121
|
-
:param hierarchy_external_id: The
|
|
3122
|
-
:param hierarchy_id: The ID of the hierarchy that
|
|
3123
|
-
:param hierarchy_logical_id: The ``LogicalID`` of the hierarchy to query for the ``PropertyLogicalID`` . You use a ``hierarchyLogicalID`` instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see `Defining relationships between
|
|
3124
|
-
:param property_external_id: The
|
|
3125
|
-
:param property_id: The ID of the property
|
|
3126
|
-
:param property_logical_id: The ``LogicalID`` of the property
|
|
3127
|
-
:param property_path: The path of the property
|
|
3112
|
+
:param hierarchy_external_id: The external ID of the hierarchy being referenced. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3113
|
+
:param hierarchy_id: The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same ``propertyId`` . For example, you might have separately grouped assets that come from the same asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3114
|
+
:param hierarchy_logical_id: The ``LogicalID`` of the hierarchy to query for the ``PropertyLogicalID`` . You use a ``hierarchyLogicalID`` instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see `Defining relationships between asset models (hierarchies) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3115
|
+
:param property_external_id: The external ID of the property being referenced. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3116
|
+
:param property_id: The ID of the property to use as the variable. You can use the property ``name`` if it's from the same asset model. If the property has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . .. epigraph:: This is a return value and can't be set.
|
|
3117
|
+
:param property_logical_id: The ``LogicalID`` of the property that is being referenced.
|
|
3118
|
+
:param property_path: The path of the property. Each step of the path is the name of the step. See the following example: ``PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite``
|
|
3128
3119
|
|
|
3129
3120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html
|
|
3130
3121
|
:exampleMetadata: fixture=_generated
|
|
@@ -3174,7 +3165,9 @@ class CfnAssetModel(
|
|
|
3174
3165
|
|
|
3175
3166
|
@builtins.property
|
|
3176
3167
|
def hierarchy_external_id(self) -> typing.Optional[builtins.str]:
|
|
3177
|
-
'''The
|
|
3168
|
+
'''The external ID of the hierarchy being referenced.
|
|
3169
|
+
|
|
3170
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3178
3171
|
|
|
3179
3172
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyexternalid
|
|
3180
3173
|
'''
|
|
@@ -3183,7 +3176,11 @@ class CfnAssetModel(
|
|
|
3183
3176
|
|
|
3184
3177
|
@builtins.property
|
|
3185
3178
|
def hierarchy_id(self) -> typing.Optional[builtins.str]:
|
|
3186
|
-
'''The ID of the hierarchy
|
|
3179
|
+
'''The ID of the hierarchy to query for the property ID.
|
|
3180
|
+
|
|
3181
|
+
You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3182
|
+
|
|
3183
|
+
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same ``propertyId`` . For example, you might have separately grouped assets that come from the same asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3187
3184
|
|
|
3188
3185
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyid
|
|
3189
3186
|
'''
|
|
@@ -3194,7 +3191,7 @@ class CfnAssetModel(
|
|
|
3194
3191
|
def hierarchy_logical_id(self) -> typing.Optional[builtins.str]:
|
|
3195
3192
|
'''The ``LogicalID`` of the hierarchy to query for the ``PropertyLogicalID`` .
|
|
3196
3193
|
|
|
3197
|
-
You use a ``hierarchyLogicalID`` instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see `Defining relationships between
|
|
3194
|
+
You use a ``hierarchyLogicalID`` instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see `Defining relationships between asset models (hierarchies) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3198
3195
|
|
|
3199
3196
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchylogicalid
|
|
3200
3197
|
'''
|
|
@@ -3203,7 +3200,9 @@ class CfnAssetModel(
|
|
|
3203
3200
|
|
|
3204
3201
|
@builtins.property
|
|
3205
3202
|
def property_external_id(self) -> typing.Optional[builtins.str]:
|
|
3206
|
-
'''The
|
|
3203
|
+
'''The external ID of the property being referenced.
|
|
3204
|
+
|
|
3205
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3207
3206
|
|
|
3208
3207
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyexternalid
|
|
3209
3208
|
'''
|
|
@@ -3212,7 +3211,12 @@ class CfnAssetModel(
|
|
|
3212
3211
|
|
|
3213
3212
|
@builtins.property
|
|
3214
3213
|
def property_id(self) -> typing.Optional[builtins.str]:
|
|
3215
|
-
'''The ID of the property
|
|
3214
|
+
'''The ID of the property to use as the variable.
|
|
3215
|
+
|
|
3216
|
+
You can use the property ``name`` if it's from the same asset model. If the property has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3217
|
+
.. epigraph::
|
|
3218
|
+
|
|
3219
|
+
This is a return value and can't be set.
|
|
3216
3220
|
|
|
3217
3221
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyid
|
|
3218
3222
|
'''
|
|
@@ -3221,7 +3225,7 @@ class CfnAssetModel(
|
|
|
3221
3225
|
|
|
3222
3226
|
@builtins.property
|
|
3223
3227
|
def property_logical_id(self) -> typing.Optional[builtins.str]:
|
|
3224
|
-
'''The ``LogicalID`` of the property
|
|
3228
|
+
'''The ``LogicalID`` of the property that is being referenced.
|
|
3225
3229
|
|
|
3226
3230
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertylogicalid
|
|
3227
3231
|
'''
|
|
@@ -3232,7 +3236,11 @@ class CfnAssetModel(
|
|
|
3232
3236
|
def property_path(
|
|
3233
3237
|
self,
|
|
3234
3238
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAssetModel.PropertyPathDefinitionProperty"]]]]:
|
|
3235
|
-
'''The path of the property
|
|
3239
|
+
'''The path of the property.
|
|
3240
|
+
|
|
3241
|
+
Each step of the path is the name of the step. See the following example:
|
|
3242
|
+
|
|
3243
|
+
``PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite``
|
|
3236
3244
|
|
|
3237
3245
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertypath
|
|
3238
3246
|
'''
|
|
@@ -3280,13 +3288,13 @@ class CfnAssetModelProps:
|
|
|
3280
3288
|
) -> None:
|
|
3281
3289
|
'''Properties for defining a ``CfnAssetModel``.
|
|
3282
3290
|
|
|
3283
|
-
:param asset_model_name: A unique, friendly name for the asset model.
|
|
3284
|
-
:param asset_model_composite_models: The composite
|
|
3291
|
+
:param asset_model_name: A unique, friendly name for the asset model.
|
|
3292
|
+
:param asset_model_composite_models: The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. .. epigraph:: When creating custom composite models, you need to use `CreateAssetModelCompositeModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html>`_ . For more information, see `Creating custom composite models (Components) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3285
3293
|
:param asset_model_description: A description for the asset model.
|
|
3286
|
-
:param asset_model_external_id: The external ID of the asset model.
|
|
3287
|
-
:param asset_model_hierarchies: The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see `
|
|
3288
|
-
:param asset_model_properties: The property definitions of the asset model. For more information, see `
|
|
3289
|
-
:param asset_model_type: The type of
|
|
3294
|
+
:param asset_model_external_id: The external ID of the asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3295
|
+
:param asset_model_hierarchies: The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 10 hierarchies per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3296
|
+
:param asset_model_properties: The property definitions of the asset model. For more information, see `Asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 200 properties per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3297
|
+
:param asset_model_type: The type of asset model. - *ASSET_MODEL* – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. - *COMPONENT_MODEL* – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
|
|
3290
3298
|
:param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3291
3299
|
|
|
3292
3300
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html
|
|
@@ -3486,8 +3494,6 @@ class CfnAssetModelProps:
|
|
|
3486
3494
|
def asset_model_name(self) -> builtins.str:
|
|
3487
3495
|
'''A unique, friendly name for the asset model.
|
|
3488
3496
|
|
|
3489
|
-
The maximum length is 256 characters with the pattern ``[^\\u0000-\\u001F\\u007F]+`` .
|
|
3490
|
-
|
|
3491
3497
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelname
|
|
3492
3498
|
'''
|
|
3493
3499
|
result = self._values.get("asset_model_name")
|
|
@@ -3498,9 +3504,12 @@ class CfnAssetModelProps:
|
|
|
3498
3504
|
def asset_model_composite_models(
|
|
3499
3505
|
self,
|
|
3500
3506
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnAssetModel.AssetModelCompositeModelProperty]]]]:
|
|
3501
|
-
'''The composite
|
|
3507
|
+
'''The composite models that are part of this asset model.
|
|
3502
3508
|
|
|
3503
|
-
|
|
3509
|
+
It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
|
|
3510
|
+
.. epigraph::
|
|
3511
|
+
|
|
3512
|
+
When creating custom composite models, you need to use `CreateAssetModelCompositeModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html>`_ . For more information, see `Creating custom composite models (Components) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3504
3513
|
|
|
3505
3514
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodels
|
|
3506
3515
|
'''
|
|
@@ -3520,6 +3529,8 @@ class CfnAssetModelProps:
|
|
|
3520
3529
|
def asset_model_external_id(self) -> typing.Optional[builtins.str]:
|
|
3521
3530
|
'''The external ID of the asset model.
|
|
3522
3531
|
|
|
3532
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3533
|
+
|
|
3523
3534
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelexternalid
|
|
3524
3535
|
'''
|
|
3525
3536
|
result = self._values.get("asset_model_external_id")
|
|
@@ -3531,7 +3542,7 @@ class CfnAssetModelProps:
|
|
|
3531
3542
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnAssetModel.AssetModelHierarchyProperty]]]]:
|
|
3532
3543
|
'''The hierarchy definitions of the asset model.
|
|
3533
3544
|
|
|
3534
|
-
Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see `
|
|
3545
|
+
Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3535
3546
|
|
|
3536
3547
|
You can specify up to 10 hierarchies per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3537
3548
|
|
|
@@ -3546,7 +3557,7 @@ class CfnAssetModelProps:
|
|
|
3546
3557
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnAssetModel.AssetModelPropertyProperty]]]]:
|
|
3547
3558
|
'''The property definitions of the asset model.
|
|
3548
3559
|
|
|
3549
|
-
For more information, see `
|
|
3560
|
+
For more information, see `Asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3550
3561
|
|
|
3551
3562
|
You can specify up to 200 properties per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3552
3563
|
|
|
@@ -3557,7 +3568,10 @@ class CfnAssetModelProps:
|
|
|
3557
3568
|
|
|
3558
3569
|
@builtins.property
|
|
3559
3570
|
def asset_model_type(self) -> typing.Optional[builtins.str]:
|
|
3560
|
-
'''The type of
|
|
3571
|
+
'''The type of asset model.
|
|
3572
|
+
|
|
3573
|
+
- *ASSET_MODEL* – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
|
|
3574
|
+
- *COMPONENT_MODEL* – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
|
|
3561
3575
|
|
|
3562
3576
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeltype
|
|
3563
3577
|
'''
|
|
@@ -3615,10 +3629,10 @@ class CfnAssetProps:
|
|
|
3615
3629
|
'''Properties for defining a ``CfnAsset``.
|
|
3616
3630
|
|
|
3617
3631
|
:param asset_model_id: The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3618
|
-
:param asset_name: A
|
|
3619
|
-
:param asset_description:
|
|
3620
|
-
:param asset_external_id: The
|
|
3621
|
-
:param asset_hierarchies: A list of asset hierarchies that each contain a ``
|
|
3632
|
+
:param asset_name: A friendly name for the asset.
|
|
3633
|
+
:param asset_description: The ID of the asset, in UUID format.
|
|
3634
|
+
:param asset_external_id: The external ID of the asset model composite model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3635
|
+
:param asset_hierarchies: A list of asset hierarchies that each contain a ``hierarchyId`` . A hierarchy specifies allowed parent/child asset relationships.
|
|
3622
3636
|
:param asset_properties: The list of asset properties for the asset. This object doesn't include properties that you define in composite models. You can find composite model properties in the ``assetCompositeModels`` object.
|
|
3623
3637
|
:param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3624
3638
|
|
|
@@ -3698,9 +3712,7 @@ class CfnAssetProps:
|
|
|
3698
3712
|
|
|
3699
3713
|
@builtins.property
|
|
3700
3714
|
def asset_name(self) -> builtins.str:
|
|
3701
|
-
'''A
|
|
3702
|
-
|
|
3703
|
-
The maximum length is 256 characters with the pattern ``[^\\u0000-\\u001F\\u007F]+`` .
|
|
3715
|
+
'''A friendly name for the asset.
|
|
3704
3716
|
|
|
3705
3717
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetname
|
|
3706
3718
|
'''
|
|
@@ -3710,7 +3722,7 @@ class CfnAssetProps:
|
|
|
3710
3722
|
|
|
3711
3723
|
@builtins.property
|
|
3712
3724
|
def asset_description(self) -> typing.Optional[builtins.str]:
|
|
3713
|
-
'''
|
|
3725
|
+
'''The ID of the asset, in UUID format.
|
|
3714
3726
|
|
|
3715
3727
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetdescription
|
|
3716
3728
|
'''
|
|
@@ -3719,7 +3731,9 @@ class CfnAssetProps:
|
|
|
3719
3731
|
|
|
3720
3732
|
@builtins.property
|
|
3721
3733
|
def asset_external_id(self) -> typing.Optional[builtins.str]:
|
|
3722
|
-
'''The
|
|
3734
|
+
'''The external ID of the asset model composite model.
|
|
3735
|
+
|
|
3736
|
+
For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
|
|
3723
3737
|
|
|
3724
3738
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetexternalid
|
|
3725
3739
|
'''
|
|
@@ -3730,7 +3744,7 @@ class CfnAssetProps:
|
|
|
3730
3744
|
def asset_hierarchies(
|
|
3731
3745
|
self,
|
|
3732
3746
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnAsset.AssetHierarchyProperty]]]]:
|
|
3733
|
-
'''A list of asset hierarchies that each contain a ``
|
|
3747
|
+
'''A list of asset hierarchies that each contain a ``hierarchyId`` .
|
|
3734
3748
|
|
|
3735
3749
|
A hierarchy specifies allowed parent/child asset relationships.
|
|
3736
3750
|
|
|
@@ -4158,7 +4172,7 @@ class CfnGateway(
|
|
|
4158
4172
|
'''
|
|
4159
4173
|
:param scope: Scope in which this resource is defined.
|
|
4160
4174
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4161
|
-
:param gateway_name: A unique, friendly name for the gateway.
|
|
4175
|
+
:param gateway_name: A unique, friendly name for the gateway.
|
|
4162
4176
|
:param gateway_platform: The gateway's platform. You can only specify one platform in a gateway.
|
|
4163
4177
|
:param gateway_capability_summaries: A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use `DescribeGatewayCapabilityConfiguration <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html>`_ .
|
|
4164
4178
|
:param tags: A list of key-value pairs that contain metadata for the gateway. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
@@ -4305,7 +4319,7 @@ class CfnGateway(
|
|
|
4305
4319
|
) -> None:
|
|
4306
4320
|
'''Contains a summary of a gateway capability configuration.
|
|
4307
4321
|
|
|
4308
|
-
:param capability_namespace: The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace ``iotsitewise:opcuacollector:version`` , where ``version`` is a number such as ``1`` .
|
|
4322
|
+
:param capability_namespace: The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace ``iotsitewise:opcuacollector:version`` , where ``version`` is a number such as ``1`` .
|
|
4309
4323
|
:param capability_configuration: The JSON document that defines the configuration for the gateway capability. For more information, see `Configuring data sources (CLI) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli>`_ in the *AWS IoT SiteWise User Guide* .
|
|
4310
4324
|
|
|
4311
4325
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html
|
|
@@ -4340,8 +4354,6 @@ class CfnGateway(
|
|
|
4340
4354
|
|
|
4341
4355
|
For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace ``iotsitewise:opcuacollector:version`` , where ``version`` is a number such as ``1`` .
|
|
4342
4356
|
|
|
4343
|
-
The maximum length is 512 characters with the pattern ``^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$`` .
|
|
4344
|
-
|
|
4345
4357
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewaycapabilitysummary.html#cfn-iotsitewise-gateway-gatewaycapabilitysummary-capabilitynamespace
|
|
4346
4358
|
'''
|
|
4347
4359
|
result = self._values.get("capability_namespace")
|
|
@@ -4459,7 +4471,7 @@ class CfnGateway(
|
|
|
4459
4471
|
|
|
4460
4472
|
To create a gateway that runs on AWS IoT Greengrass , you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to AWS IoT SiteWise . For more information, see `Ingesting data using a gateway <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
4461
4473
|
|
|
4462
|
-
:param group_arn: The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the Greengrass group. For more information about how to find a group's ARN, see `ListGroups <https://docs.aws.amazon.com/greengrass/
|
|
4474
|
+
:param group_arn: The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the Greengrass group. For more information about how to find a group's ARN, see `ListGroups <https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html>`_ and `GetGroup <https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html>`_ in the *AWS IoT Greengrass V1 API Reference* .
|
|
4463
4475
|
|
|
4464
4476
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrass.html
|
|
4465
4477
|
:exampleMetadata: fixture=_generated
|
|
@@ -4483,7 +4495,7 @@ class CfnGateway(
|
|
|
4483
4495
|
|
|
4484
4496
|
@builtins.property
|
|
4485
4497
|
def group_arn(self) -> builtins.str:
|
|
4486
|
-
'''The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the Greengrass group. For more information about how to find a group's ARN, see `ListGroups <https://docs.aws.amazon.com/greengrass/
|
|
4498
|
+
'''The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the Greengrass group. For more information about how to find a group's ARN, see `ListGroups <https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html>`_ and `GetGroup <https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html>`_ in the *AWS IoT Greengrass V1 API Reference* .
|
|
4487
4499
|
|
|
4488
4500
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-greengrass.html#cfn-iotsitewise-gateway-greengrass-grouparn
|
|
4489
4501
|
'''
|
|
@@ -4578,7 +4590,7 @@ class CfnGatewayProps:
|
|
|
4578
4590
|
) -> None:
|
|
4579
4591
|
'''Properties for defining a ``CfnGateway``.
|
|
4580
4592
|
|
|
4581
|
-
:param gateway_name: A unique, friendly name for the gateway.
|
|
4593
|
+
:param gateway_name: A unique, friendly name for the gateway.
|
|
4582
4594
|
:param gateway_platform: The gateway's platform. You can only specify one platform in a gateway.
|
|
4583
4595
|
:param gateway_capability_summaries: A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use `DescribeGatewayCapabilityConfiguration <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html>`_ .
|
|
4584
4596
|
:param tags: A list of key-value pairs that contain metadata for the gateway. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
@@ -4635,8 +4647,6 @@ class CfnGatewayProps:
|
|
|
4635
4647
|
def gateway_name(self) -> builtins.str:
|
|
4636
4648
|
'''A unique, friendly name for the gateway.
|
|
4637
4649
|
|
|
4638
|
-
The maximum length is 256 characters with the pattern ``[^\\u0000-\\u001F\\u007F]+`` .
|
|
4639
|
-
|
|
4640
4650
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayname
|
|
4641
4651
|
'''
|
|
4642
4652
|
result = self._values.get("gateway_name")
|
|
@@ -4701,10 +4711,10 @@ class CfnPortal(
|
|
|
4701
4711
|
):
|
|
4702
4712
|
'''Creates a portal, which can contain projects and dashboards.
|
|
4703
4713
|
|
|
4704
|
-
|
|
4714
|
+
AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.
|
|
4705
4715
|
.. epigraph::
|
|
4706
4716
|
|
|
4707
|
-
Before you can sign in to a new portal, you must add at least one
|
|
4717
|
+
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see `Adding or removing portal administrators <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins>`_ in the *AWS IoT SiteWise User Guide* .
|
|
4708
4718
|
|
|
4709
4719
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html
|
|
4710
4720
|
:cloudformationResource: AWS::IoTSiteWise::Portal
|
|
@@ -4757,7 +4767,7 @@ class CfnPortal(
|
|
|
4757
4767
|
:param role_arn: The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see `Using service roles for AWS IoT SiteWise Monitor <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
4758
4768
|
:param alarms: Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see `Monitoring with alarms <https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html>`_ in the *AWS IoT SiteWise Application Guide* .
|
|
4759
4769
|
:param notification_sender_email: The email address that sends alarm notifications. .. epigraph:: If you use the `AWS IoT Events managed Lambda function <https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html>`_ to manage your emails, you must `verify the sender email address in Amazon SES <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html>`_ .
|
|
4760
|
-
:param portal_auth_mode: The service to use to authenticate users to the portal. Choose from the following options:. - ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center
|
|
4770
|
+
:param portal_auth_mode: The service to use to authenticate users to the portal. Choose from the following options:. - ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see `Enabling IAM Identity Center <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso>`_ in the *AWS IoT SiteWise User Guide* . This option is only available in AWS Regions other than the China Regions. - ``IAM`` – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions. You can't change this value after you create a portal. Default: ``SSO``
|
|
4761
4771
|
:param portal_description: A description for the portal.
|
|
4762
4772
|
:param tags: A list of key-value pairs that contain metadata for the portal. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
4763
4773
|
'''
|
|
@@ -5074,7 +5084,7 @@ class CfnPortalProps:
|
|
|
5074
5084
|
:param role_arn: The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see `Using service roles for AWS IoT SiteWise Monitor <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
5075
5085
|
:param alarms: Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see `Monitoring with alarms <https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html>`_ in the *AWS IoT SiteWise Application Guide* .
|
|
5076
5086
|
:param notification_sender_email: The email address that sends alarm notifications. .. epigraph:: If you use the `AWS IoT Events managed Lambda function <https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html>`_ to manage your emails, you must `verify the sender email address in Amazon SES <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html>`_ .
|
|
5077
|
-
:param portal_auth_mode: The service to use to authenticate users to the portal. Choose from the following options:. - ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center
|
|
5087
|
+
:param portal_auth_mode: The service to use to authenticate users to the portal. Choose from the following options:. - ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see `Enabling IAM Identity Center <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso>`_ in the *AWS IoT SiteWise User Guide* . This option is only available in AWS Regions other than the China Regions. - ``IAM`` – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions. You can't change this value after you create a portal. Default: ``SSO``
|
|
5078
5088
|
:param portal_description: A description for the portal.
|
|
5079
5089
|
:param tags: A list of key-value pairs that contain metadata for the portal. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
|
|
5080
5090
|
|
|
@@ -5189,8 +5199,8 @@ class CfnPortalProps:
|
|
|
5189
5199
|
def portal_auth_mode(self) -> typing.Optional[builtins.str]:
|
|
5190
5200
|
'''The service to use to authenticate users to the portal. Choose from the following options:.
|
|
5191
5201
|
|
|
5192
|
-
- ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center
|
|
5193
|
-
- ``IAM`` – The portal uses AWS Identity and Access Management
|
|
5202
|
+
- ``SSO`` – The portal uses AWS IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see `Enabling IAM Identity Center <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso>`_ in the *AWS IoT SiteWise User Guide* . This option is only available in AWS Regions other than the China Regions.
|
|
5203
|
+
- ``IAM`` – The portal uses AWS Identity and Access Management to authenticate users and manage user permissions.
|
|
5194
5204
|
|
|
5195
5205
|
You can't change this value after you create a portal.
|
|
5196
5206
|
|