Class CfnComponentTypeProps

Properties for defining a CfnComponentType.

Inheritance

object

CfnComponentTypeProps

Implements

ICfnComponentTypeProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IoTTwinMaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnComponentTypeProps : ICfnComponentTypeProps

Syntax (vb)

Public Class CfnComponentTypeProps Implements ICfnComponentTypeProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.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;

             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

CfnComponentTypeProps()

Properties for defining a CfnComponentType.

Properties

ComponentTypeId	The ID of the component type.
CompositeComponentTypes	Maps strings to `compositeComponentTypes` of the `componentType` .
Description	The description of the component type.
ExtendsFrom	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.
IsSingleton	A boolean value that specifies whether an entity can have more than one component of this type.
PropertyDefinitions	An object that maps strings to the property definitions in the component type.
PropertyGroups	An object that maps strings to the property groups in the component type.
Tags	The ComponentType tags.
WorkspaceId	The ID of the workspace that contains the component type.

Constructors

CfnComponentTypeProps()

Properties for defining a CfnComponentType.

public CfnComponentTypeProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.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;

             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" }
                 }
             };

Properties

ComponentTypeId

The ID of the component type.

public string ComponentTypeId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-componenttypeid

CompositeComponentTypes

Maps strings to compositeComponentTypes of the componentType .

public object? CompositeComponentTypes { get; set; }

Property Value

object

Remarks

CompositeComponentType is referenced by componentTypeId .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-compositecomponenttypes

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnComponentType.ICompositeComponentTypeProperty>

Description

The description of the component type.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-description

ExtendsFrom

The name of the parent component type that this component type extends.

public string[]? ExtendsFrom { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-extendsfrom

Functions

An object that maps strings to the functions in the component type.

public object? Functions { get; set; }

Property Value

object

Remarks

Each string in the mapping must be unique to this object.

For information on the FunctionResponse object see the FunctionResponse API reference.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-functions

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnComponentType.IFunctionProperty>

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

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-issingleton

Type union: either bool or IResolvable

PropertyDefinitions

An object that maps strings to the property definitions in the component type.

public object? PropertyDefinitions { get; set; }

Property Value

object

Remarks

Each string in the mapping must be unique to this object.

For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertydefinitions

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnComponentType.IPropertyDefinitionProperty>

PropertyGroups

An object that maps strings to the property groups in the component type.

public object? PropertyGroups { get; set; }

Property Value

object

Remarks

Each string in the mapping must be unique to this object.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertygroups

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnComponentType.IPropertyGroupProperty>

WorkspaceId

The ID of the workspace that contains the component type.

public string WorkspaceId { get; set; }