Class CfnComponentTypeProps
Properties for defining a CfnComponentType.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoTTwinMaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnComponentTypeProps : Object, ICfnComponentTypePropsSyntax (vb)
Public Class CfnComponentTypeProps
Inherits Object
Implements ICfnComponentTypePropsRemarks
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;
DataTypeProperty dataTypeProperty_;
DataValueProperty dataValueProperty_;
var relationshipValue;
var cfnComponentTypeProps = new CfnComponentTypeProps {
ComponentTypeId = "componentTypeId",
WorkspaceId = "workspaceId",
// the properties below are optional
CompositeComponentTypes = new Dictionary<string, object> {
{ "compositeComponentTypesKey", new CompositeComponentTypeProperty {
ComponentTypeId = "componentTypeId"
} }
},
Description = "description",
ExtendsFrom = new [] { "extendsFrom" },
Functions = new Dictionary<string, object> {
{ "functionsKey", new FunctionProperty {
ImplementedBy = new DataConnectorProperty {
IsNative = false,
Lambda = new LambdaFunctionProperty {
Arn = "arn"
}
},
RequiredProperties = new [] { "requiredProperties" },
Scope = "scope"
} }
},
IsSingleton = false,
PropertyDefinitions = new Dictionary<string, object> {
{ "propertyDefinitionsKey", new PropertyDefinitionProperty {
Configurations = new Dictionary<string, string> {
{ "configurationsKey", "configurations" }
},
DataType = new DataTypeProperty {
Type = "type",
// the properties below are optional
AllowedValues = new [] { 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"
} },
NestedType = dataTypeProperty_,
Relationship = new RelationshipProperty {
RelationshipType = "relationshipType",
TargetComponentTypeId = "targetComponentTypeId"
},
UnitOfMeasure = "unitOfMeasure"
},
DefaultValue = 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"
},
IsExternalId = false,
IsRequiredInEntity = false,
IsStoredExternally = false,
IsTimeSeries = false
} }
},
PropertyGroups = new Dictionary<string, object> {
{ "propertyGroupsKey", new PropertyGroupProperty {
GroupType = "groupType",
PropertyNames = new [] { "propertyNames" }
} }
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
};Synopsis
Constructors
| Cfn |
Properties
| Component |
The ID of the component type. |
| Composite |
Maps strings to |
| Description | The description of the component type. |
| Extends |
The name of the parent component type that this component type extends. |
| Functions | An object that maps strings to the functions in the component type. |
| Is |
A boolean value that specifies whether an entity can have more than one component of this type. |
| Property |
An object that maps strings to the property definitions in the component type. |
| Property |
An object that maps strings to the property groups in the component type. |
| Tags | The ComponentType tags. |
| Workspace |
The ID of the workspace that contains the component type. |
Constructors
CfnComponentTypeProps()
public CfnComponentTypeProps()Properties
ComponentTypeId
The ID of the component type.
public string ComponentTypeId { get; set; }Property Value
System.
Remarks
CompositeComponentTypes
Maps strings to compositeComponentTypes of the componentType .
public object CompositeComponentTypes { get; set; }Property Value
System.
Remarks
CompositeComponentType is referenced by componentTypeId .
Description
The description of the component type.
public string Description { get; set; }Property Value
System.
Remarks
ExtendsFrom
The name of the parent component type that this component type extends.
public string[] ExtendsFrom { get; set; }Property Value
System.
Remarks
Functions
An object that maps strings to the functions in the component type.
public object Functions { get; set; }Property Value
System.
Remarks
Each string in the mapping must be unique to this object.
For information on the FunctionResponse object see the FunctionResponse API reference.
IsSingleton
A boolean value that specifies whether an entity can have more than one component of this type.
public object IsSingleton { get; set; }Property Value
System.
Remarks
PropertyDefinitions
An object that maps strings to the property definitions in the component type.
public object PropertyDefinitions { get; set; }Property Value
System.
Remarks
Each string in the mapping must be unique to this object.
For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.
PropertyGroups
An object that maps strings to the property groups in the component type.
public object PropertyGroups { get; set; }Property Value
System.
Remarks
Each string in the mapping must be unique to this object.
Tags
The ComponentType tags.
public IDictionary<string, string> Tags { get; set; }Property Value
System.
Remarks
WorkspaceId
The ID of the workspace that contains the component type.
public string WorkspaceId { get; set; }Property Value
System.