Class CfnAsset
Creates an asset from an existing asset model.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAsset : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnAsset
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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
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",
AssetExternalId = "assetExternalId",
AssetHierarchies = new [] { new AssetHierarchyProperty {
ChildAssetId = "childAssetId",
// the properties below are optional
ExternalId = "externalId",
Id = "id",
LogicalId = "logicalId"
} },
AssetProperties = new [] { new AssetPropertyProperty {
Alias = "alias",
ExternalId = "externalId",
Id = "id",
LogicalId = "logicalId",
NotificationState = "notificationState",
Unit = "unit"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
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 |
CfnAsset(Construct, String, ICfnAssetProps) |
Properties
AssetDescription | The ID of the asset, in UUID format. |
AssetExternalId | The external ID of the asset model composite model. |
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 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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnAsset(Construct, String, ICfnAssetProps)
public CfnAsset(Construct scope, string id, ICfnAssetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAssetProps
Resource properties.
Properties
AssetDescription
The ID of the asset, in UUID format.
public virtual string AssetDescription { get; set; }
Property Value
System.String
AssetExternalId
The external ID of the asset model composite model.
public virtual string AssetExternalId { get; set; }
Property Value
System.String
AssetHierarchies
A list of asset hierarchies that each contain a hierarchyId
.
public virtual object AssetHierarchies { get; set; }
Property Value
System.Object
AssetModelId
The ID of the asset model from which to create the asset.
public virtual string AssetModelId { get; set; }
Property Value
System.String
AssetName
A friendly name for the asset.
public virtual string AssetName { get; set; }
Property Value
System.String
AssetProperties
The list of asset properties for the asset.
public virtual object AssetProperties { get; set; }
Property Value
System.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
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of key-value pairs that contain metadata for the asset.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>