Show / Hide Table of Contents

Class CfnEntityMixinProps

Properties for CfnEntityPropsMixin.

Inheritance
object
CfnEntityMixinProps
Implements
ICfnEntityMixinProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoTTwinMaker
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnEntityMixinProps : ICfnEntityMixinProps
Syntax (vb)
Public Class CfnEntityMixinProps Implements ICfnEntityMixinProps
Remarks

See: 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.CfnPropertyMixins.AWS.IoTTwinMaker;

             DataValueProperty dataValueProperty_;
             var definition;
             var error;
             var relationshipValue;

             var cfnEntityMixinProps = new CfnEntityMixinProps {
                 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"
                         }
                     } }
                 },
                 CompositeComponents = new Dictionary<string, object> {
                     { "compositeComponentsKey", new CompositeComponentProperty {
                         ComponentName = "componentName",
                         ComponentPath = "componentPath",
                         ComponentTypeId = "componentTypeId",
                         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",
                 EntityName = "entityName",
                 ParentEntityId = "parentEntityId",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 WorkspaceId = "workspaceId"
             };

Synopsis

Constructors

CfnEntityMixinProps()

Properties for CfnEntityPropsMixin.

Properties

Components

An object that maps strings to the components in the entity.

CompositeComponents

Maps string to compositeComponent updates in the request.

Description

The description of the entity.

EntityId

The ID of the entity.

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 that contains the entity.

Constructors

CfnEntityMixinProps()

Properties for CfnEntityPropsMixin.

public CfnEntityMixinProps()
Remarks

See: 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.CfnPropertyMixins.AWS.IoTTwinMaker;

             DataValueProperty dataValueProperty_;
             var definition;
             var error;
             var relationshipValue;

             var cfnEntityMixinProps = new CfnEntityMixinProps {
                 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"
                         }
                     } }
                 },
                 CompositeComponents = new Dictionary<string, object> {
                     { "compositeComponentsKey", new CompositeComponentProperty {
                         ComponentName = "componentName",
                         ComponentPath = "componentPath",
                         ComponentTypeId = "componentTypeId",
                         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",
                 EntityName = "entityName",
                 ParentEntityId = "parentEntityId",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 WorkspaceId = "workspaceId"
             };

Properties

Components

An object that maps strings to the components in the entity.

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

object

Remarks

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

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

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

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnEntityPropsMixin.IComponentProperty>

CompositeComponents

Maps string to compositeComponent updates in the request.

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

object

Remarks

Each key of the map represents the componentPath of the compositeComponent .

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

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnEntityPropsMixin.ICompositeComponentProperty>

Description

The description of the entity.

public string? Description { get; set; }
Property Value

string

Remarks

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

EntityId

The ID of the entity.

public string? EntityId { get; set; }
Property Value

string

Remarks

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

EntityName

The entity name.

public string? EntityName { get; set; }
Property Value

string

Remarks

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

ParentEntityId

The ID of the parent entity.

public string? ParentEntityId { get; set; }
Property Value

string

Remarks

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

Tags

Metadata that you can use to manage the entity.

public IDictionary<string, string>? Tags { get; set; }
Property Value

IDictionary<string, string>

Remarks

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

WorkspaceId

The ID of the workspace that contains the entity.

public string? WorkspaceId { get; set; }
Property Value

string

Remarks

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

Implements

ICfnEntityMixinProps
Back to top Generated by DocFX