Class CfnAsset
A CloudFormation AWS::IoTSiteWise::Asset
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.AWS.IoTSiteWise.dll
Syntax (csharp)
public class CfnAsset : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAsset
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide .
CloudformationResource: AWS::IoTSiteWise::Asset
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTSiteWise;
var cfnAsset = new CfnAsset(this, "MyCfnAsset", new CfnAssetProps {
AssetModelId = "assetModelId",
AssetName = "assetName",
// the properties below are optional
AssetDescription = "assetDescription",
AssetHierarchies = new [] { new AssetHierarchyProperty {
ChildAssetId = "childAssetId",
LogicalId = "logicalId"
} },
AssetProperties = new [] { new AssetPropertyProperty {
LogicalId = "logicalId",
// the properties below are optional
Alias = "alias",
NotificationState = "notificationState",
Unit = "unit"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnAsset(Construct, String, ICfnAssetProps) | Create a new |
CfnAsset(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAsset(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AssetDescription | A description for the asset. |
AssetHierarchies | A list of asset hierarchies that each contain a |
AssetModelId | The ID of the asset model from which to create the asset. |
AssetName | A unique, friendly name for the asset. |
AssetProperties | The list of asset properties for the asset. |
AttrAssetArn | The ARN of the asset. |
AttrAssetId | The ID of the asset. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Tags | A list of key-value pairs that contain metadata for the asset. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAsset(Construct, String, ICfnAssetProps)
Create a new AWS::IoTSiteWise::Asset
.
public CfnAsset(Construct scope, string id, ICfnAssetProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAssetProps
- resource properties.
CfnAsset(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAsset(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAsset(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAsset(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AssetDescription
A description for the asset.
public virtual string AssetDescription { get; set; }
Property Value
System.String
Remarks
AssetHierarchies
A list of asset hierarchies that each contain a hierarchyLogicalId
.
public virtual object AssetHierarchies { get; set; }
Property Value
System.Object
Remarks
A hierarchy specifies allowed parent/child asset relationships.
AssetModelId
The ID of the asset model from which to create the asset.
public virtual string AssetModelId { get; set; }
Property Value
System.String
Remarks
AssetName
A unique, friendly name for the asset.
public virtual string AssetName { get; set; }
Property Value
System.String
Remarks
The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+
.
AssetProperties
The list of asset properties for the asset.
public virtual object AssetProperties { get; set; }
Property Value
System.Object
Remarks
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels
object.
AttrAssetArn
The ARN of the asset.
public virtual string AttrAssetArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AssetArn
AttrAssetId
The ID of the asset.
public virtual string AttrAssetId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AssetId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Tags
A list of key-value pairs that contain metadata for the asset.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>