Class CfnEntityProps
Properties for defining a CfnEntity
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoTTwinMaker
Assembly: Amazon.CDK.AWS.IoTTwinMaker.dll
Syntax (csharp)
public class CfnEntityProps : Object, ICfnEntityProps
Syntax (vb)
Public Class CfnEntityProps
Inherits Object
Implements ICfnEntityProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.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.IoTTwinMaker;
DataValueProperty dataValueProperty_;
var definition;
var error;
var relationshipValue;
var cfnEntityProps = new CfnEntityProps {
EntityName = "entityName",
WorkspaceId = "workspaceId",
// the properties below are optional
Components = new Dictionary<string, object> {
{ "componentsKey", new ComponentProperty {
ComponentName = "componentName",
ComponentTypeId = "componentTypeId",
DefinedIn = "definedIn",
Description = "description",
Properties = new Dictionary<string, object> {
{ "propertiesKey", new PropertyProperty {
Definition = definition,
Value = new DataValueProperty {
BooleanValue = false,
DoubleValue = 123,
Expression = "expression",
IntegerValue = 123,
ListValue = new [] { dataValueProperty_ },
LongValue = 123,
MapValue = new Dictionary<string, object> {
{ "mapValueKey", dataValueProperty_ }
},
RelationshipValue = relationshipValue,
StringValue = "stringValue"
}
} }
},
PropertyGroups = new Dictionary<string, object> {
{ "propertyGroupsKey", new PropertyGroupProperty {
GroupType = "groupType",
PropertyNames = new [] { "propertyNames" }
} }
},
Status = new StatusProperty {
Error = error,
State = "state"
}
} }
},
Description = "description",
EntityId = "entityId",
ParentEntityId = "parentEntityId",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
};
Synopsis
Constructors
CfnEntityProps() |
Properties
Components | An object that maps strings to the components in the entity. |
Description | The description of the entity. |
EntityId | The entity ID. |
EntityName | The entity name. |
ParentEntityId | The ID of the parent entity. |
Tags | Metadata that you can use to manage the entity. |
WorkspaceId | The ID of the workspace. |
Constructors
CfnEntityProps()
public CfnEntityProps()
Properties
Components
An object that maps strings to the components in the entity.
public object Components { get; set; }
Property Value
System.Object
Remarks
Each string in the mapping must be unique to this object.
For information on the component object see the component API reference.
Description
The description of the entity.
public string Description { get; set; }
Property Value
System.String
Remarks
EntityId
The entity ID.
public string EntityId { get; set; }
Property Value
System.String
Remarks
EntityName
The entity name.
public string EntityName { get; set; }
Property Value
System.String
Remarks
ParentEntityId
The ID of the parent entity.
public string ParentEntityId { get; set; }
Property Value
System.String
Remarks
Tags
Metadata that you can use to manage the entity.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
WorkspaceId
The ID of the workspace.
public string WorkspaceId { get; set; }
Property Value
System.String