Class CfnComponentType

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnComponentType

Implements

IInspectable

IComponentTypeRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTTwinMaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnComponentType : CfnResource, IInspectable, IComponentTypeRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnComponentType Inherits CfnResource Implements IInspectable, IComponentTypeRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

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 cfnComponentType = new CfnComponentType(this, "MyCfnComponentType", 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

CfnComponentType(Construct, string, ICfnComponentTypeProps)

Create a new AWS::IoTTwinMaker::ComponentType.

Properties

AttrArn	The ARN of the component type.
AttrCreationDateTime	The date and time when the component type was created.
AttrIsAbstract	A boolean value that specifies whether the component type is abstract.
AttrIsSchemaInitialized	A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
AttrStatus	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.
AttrStatusError	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.
AttrStatusErrorCode	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.
AttrStatusErrorMessage	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.
AttrStatusState	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.
AttrUpdateDateTime	The component type the update time.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.
ComponentTypeId	The ID of the component type.
ComponentTypeRef	A reference to a ComponentType resource.
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	Tag Manager which manages the tags for this resource.
TagsRaw	The ComponentType tags.
WorkspaceId	The ID of the workspace that contains the component type.

Methods

ArnForComponentType(IComponentTypeRef)	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnComponentType(object)	Checks whether the given object is a CfnComponentType.
RenderProperties(IDictionary<string, object>)	Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

Constructors

CfnComponentType(Construct, string, ICfnComponentTypeProps)

Create a new AWS::IoTTwinMaker::ComponentType.

public CfnComponentType(Construct scope, string id, ICfnComponentTypeProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnComponentTypeProps

Resource properties.

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the component type.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreationDateTime

The date and time when the component type was created.

public virtual string AttrCreationDateTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationDateTime

AttrIsAbstract

A boolean value that specifies whether the component type is abstract.

public virtual IResolvable AttrIsAbstract { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: IsAbstract

AttrIsSchemaInitialized

A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

public virtual IResolvable AttrIsSchemaInitialized { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: IsSchemaInitialized

AttrStatus

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

public virtual IResolvable AttrStatus { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: Status

AttrStatusError

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

public virtual IResolvable AttrStatusError { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: Status.Error

AttrStatusErrorCode

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

public virtual string AttrStatusErrorCode { get; }

Property Value

string

Remarks

CloudformationAttribute: Status.Error.Code

AttrStatusErrorMessage

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

public virtual string AttrStatusErrorMessage { get; }

Property Value

string

Remarks

CloudformationAttribute: Status.Error.Message

AttrStatusState

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

public virtual string AttrStatusState { get; }

Property Value

string

Remarks

CloudformationAttribute: Status.State

AttrUpdateDateTime

The component type the update time.

public virtual string AttrUpdateDateTime { get; }

Property Value

string

Remarks

CloudformationAttribute: UpdateDateTime

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

CfnProperties

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

ComponentTypeId

The ID of the component type.

public virtual string ComponentTypeId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

ComponentTypeRef

A reference to a ComponentType resource.

public virtual IComponentTypeReference ComponentTypeRef { get; }

Property Value

IComponentTypeReference

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

CompositeComponentTypes

Maps strings to compositeComponentTypes of the componentType .

public virtual object? CompositeComponentTypes { get; set; }

Property Value

object

Remarks

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

Description

The description of the component type.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

ExtendsFrom

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

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

Property Value

string[]

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

Functions

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

public virtual object? Functions { get; set; }

Property Value

object

Remarks

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 virtual object? IsSingleton { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

PropertyDefinitions

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

public virtual object? PropertyDefinitions { get; set; }

Property Value

object

Remarks

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 virtual object? PropertyGroups { get; set; }

Property Value

object

Remarks

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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

TagsRaw

The ComponentType tags.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

WorkspaceId

The ID of the workspace that contains the component type.

public virtual string WorkspaceId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

Methods

ArnForComponentType(IComponentTypeRef)

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

public static string ArnForComponentType(IComponentTypeRef resource)

Parameters

resource IComponentTypeRef

Returns

string

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

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 cfnComponentType = new CfnComponentType(this, "MyCfnComponentType", 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" }
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

IsCfnComponentType(object)

Checks whether the given object is a CfnComponentType.

public static bool IsCfnComponentType(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::IoTTwinMaker::ComponentType

ExampleMetadata: fixture=_generated

Implements

IInspectable

IComponentTypeRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable