Class CfnAsset

Creates an asset from an existing asset model.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAsset

Implements

IInspectable

IAssetRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAsset : CfnResource, IInspectable, IAssetRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnAsset Inherits CfnResource Implements IInspectable, IAssetRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnAssetProps)

Creates an asset from an existing asset model.

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 hierarchyId .
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.
AssetRef	A reference to a Asset resource.
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	Creates an asset from an existing asset model.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A list of key-value pairs that contain metadata for the asset.

Methods

FromAssetArn(Construct, string, string)	Creates a new IAssetRef from an ARN.
FromAssetId(Construct, string, string)	Creates a new IAssetRef from a assetId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates an asset from an existing asset model.

Constructors

CfnAsset(Construct, string, ICfnAssetProps)

Creates an asset from an existing asset model.

public CfnAsset(Construct scope, string id, ICfnAssetProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAssetProps

Resource properties.

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

Properties

AssetDescription

The ID of the asset, in UUID format.

public virtual string? AssetDescription { get; set; }

Property Value

string

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

AssetExternalId

The external ID of the asset model composite model.

public virtual string? AssetExternalId { get; set; }

Property Value

string

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

AssetHierarchies

A list of asset hierarchies that each contain a hierarchyId .

public virtual object? AssetHierarchies { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnAsset.IAssetHierarchyProperty)[]

AssetModelId

The ID of the asset model from which to create the asset.

public virtual string AssetModelId { get; set; }

Property Value

string

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

AssetName

A friendly name for the asset.

public virtual string AssetName { get; set; }

Property Value

string

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

AssetProperties

The list of asset properties for the asset.

public virtual object? AssetProperties { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnAsset.IAssetPropertyProperty)[]

AssetRef

A reference to a Asset resource.

public virtual IAssetReference AssetRef { get; }

Property Value

IAssetReference

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

AttrAssetArn

The ARN of the asset.

public virtual string AttrAssetArn { get; }

Property Value

string

Remarks

CloudformationAttribute: AssetArn

AttrAssetId

The ID of the asset.

public virtual string AttrAssetId { get; }

Property Value

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

string

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

CfnProperties

Creates an asset from an existing asset model.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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

TagsRaw

A list of key-value pairs that contain metadata for the asset.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

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

Methods

FromAssetArn(Construct, string, string)

Creates a new IAssetRef from an ARN.

public static IAssetRef FromAssetArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IAssetRef

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

FromAssetId(Construct, string, string)

Creates a new IAssetRef from a assetId.

public static IAssetRef FromAssetId(Construct scope, string id, string assetId)

Parameters

scope Construct

id string

assetId string

Returns

IAssetRef

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

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.

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

RenderProperties(IDictionary<string, object>)

Creates an asset from an existing asset model.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable

IAssetRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable