CfnAssetPropsMixin

class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnAssetPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an asset from an existing asset model.

For more information, see Creating assets in the AWS IoT SiteWise User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html
CloudformationResource:: AWS::IoTSiteWise::Asset
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

cfn_asset_props_mixin = iotsitewise_mixins.CfnAssetPropsMixin(iotsitewise_mixins.CfnAssetMixinProps(
    asset_description="assetDescription",
    asset_external_id="assetExternalId",
    asset_hierarchies=[iotsitewise_mixins.CfnAssetPropsMixin.AssetHierarchyProperty(
        child_asset_id="childAssetId",
        external_id="externalId",
        id="id",
        logical_id="logicalId"
    )],
    asset_model_id="assetModelId",
    asset_name="assetName",
    asset_properties=[iotsitewise_mixins.CfnAssetPropsMixin.AssetPropertyProperty(
        alias="alias",
        external_id="externalId",
        id="id",
        logical_id="logicalId",
        notification_state="notificationState",
        unit="unit"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTSiteWise::Asset.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['assetDescription', 'assetExternalId', 'assetHierarchies', 'assetModelId', 'assetName', 'assetProperties', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

AssetHierarchyProperty

class CfnAssetPropsMixin.AssetHierarchyProperty(*, child_asset_id=None, external_id=None, id=None, logical_id=None)

Bases: object

Describes an asset hierarchy that contains a hierarchy’s name and ID.

Parameters:

child_asset_id (Optional[str]) – The Id of the child asset.
external_id (Optional[str]) – 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 in the AWS IoT SiteWise User Guide .
id (Optional[str]) – The ID of the hierarchy. This ID is a hierarchyId . .. epigraph:: This is a return value and can’t be set.
logical_id (Optional[str]) – The ID of the hierarchy. This ID is a hierarchyId .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

asset_hierarchy_property = iotsitewise_mixins.CfnAssetPropsMixin.AssetHierarchyProperty(
    child_asset_id="childAssetId",
    external_id="externalId",
    id="id",
    logical_id="logicalId"
)

Attributes

child_asset_id

The Id of the child asset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-childassetid

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 in the AWS IoT SiteWise User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-externalid

id

The ID of the hierarchy. This ID is a hierarchyId .

This is a return value and can’t be set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-id

logical_id

The ID of the hierarchy.

This ID is a hierarchyId .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-logicalid

AssetPropertyProperty

class CfnAssetPropsMixin.AssetPropertyProperty(*, alias=None, external_id=None, id=None, logical_id=None, notification_state=None, unit=None)

Bases: object

Contains asset property information.

Parameters:

alias (Optional[str]) – 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 in the AWS IoT SiteWise User Guide .
external_id (Optional[str]) –
The external ID of the property. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
id (Optional[str]) – The ID of the asset property. .. epigraph:: This is a return value and can’t be set.
logical_id (Optional[str]) – The LogicalID of the asset property.
notification_state (Optional[str]) – 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 in the AWS IoT SiteWise User Guide . If you omit this parameter, the notification state is set to DISABLED .
unit (Optional[str]) – The unit (such as Newtons or RPM ) of the asset property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins

asset_property_property = iotsitewise_mixins.CfnAssetPropsMixin.AssetPropertyProperty(
    alias="alias",
    external_id="externalId",
    id="id",
    logical_id="logicalId",
    notification_state="notificationState",
    unit="unit"
)

Attributes

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 in the AWS IoT SiteWise User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-alias

external_id

The external ID of the property.

For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-externalid

id

The ID of the asset property.

This is a return value and can’t be set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-id

logical_id

The LogicalID of the asset property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-logicalid

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 in the AWS IoT SiteWise User Guide .

If you omit this parameter, the notification state is set to DISABLED .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-notificationstate

unit

The unit (such as Newtons or RPM ) of the asset property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-unit