Show / Hide Table of Contents

Class CfnComponentType.PropertyDefinitionProperty

PropertyDefinition is an object that maps strings to the property definitions in the component type.

Inheritance
object
CfnComponentType.PropertyDefinitionProperty
Implements
CfnComponentType.IPropertyDefinitionProperty
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 CfnComponentType.PropertyDefinitionProperty : CfnComponentType.IPropertyDefinitionProperty
Syntax (vb)
Public Class CfnComponentType.PropertyDefinitionProperty Implements CfnComponentType.IPropertyDefinitionProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.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 propertyDefinitionProperty = 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
             };

Synopsis

Constructors

PropertyDefinitionProperty()

PropertyDefinition is an object that maps strings to the property definitions in the component type.

Properties

Configurations

A mapping that specifies configuration information about the property.

DataType

An object that specifies the data type of a property.

DefaultValue

A boolean value that specifies whether the property ID comes from an external data store.

IsExternalId

A Boolean value that specifies whether the property ID comes from an external data source.

IsRequiredInEntity

A boolean value that specifies whether the property is required in an entity.

IsStoredExternally

A boolean value that specifies whether the property is stored externally.

IsTimeSeries

A boolean value that specifies whether the property consists of time series data.

Constructors

PropertyDefinitionProperty()

PropertyDefinition is an object that maps strings to the property definitions in the component type.

public PropertyDefinitionProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.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 propertyDefinitionProperty = 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
             };

Properties

Configurations

A mapping that specifies configuration information about the property.

public object? Configurations { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-configurations

Type union: either Dictionary<string, string> or IResolvable

DataType

An object that specifies the data type of a property.

public object? DataType { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-datatype

Type union: either IResolvable or CfnComponentType.IDataTypeProperty

DefaultValue

A boolean value that specifies whether the property ID comes from an external data store.

public object? DefaultValue { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-defaultvalue

Type union: either IResolvable or CfnComponentType.IDataValueProperty

IsExternalId

A Boolean value that specifies whether the property ID comes from an external data source.

public object? IsExternalId { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isexternalid

Type union: either bool or IResolvable

IsRequiredInEntity

A boolean value that specifies whether the property is required in an entity.

public object? IsRequiredInEntity { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isrequiredinentity

Type union: either bool or IResolvable

IsStoredExternally

A boolean value that specifies whether the property is stored externally.

public object? IsStoredExternally { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isstoredexternally

Type union: either bool or IResolvable

IsTimeSeries

A boolean value that specifies whether the property consists of time series data.

public object? IsTimeSeries { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-istimeseries

Type union: either bool or IResolvable

Implements

CfnComponentType.IPropertyDefinitionProperty
Back to top Generated by DocFX