Class CfnComponentType
Use the AWS::IoTTwinMaker::ComponentType
resource to declare a component type.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTTwinMaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnComponentType : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnComponentType
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnComponentType(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnComponentType(Construct, String, ICfnComponentTypeProps) |
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 | |
AttrStatusError | |
AttrStatusErrorCode | |
AttrStatusErrorMessage | |
AttrStatusState | |
AttrUpdateDateTime | The component type the update time. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ComponentTypeId | The ID of the component type. |
CompositeComponentTypes | Maps strings to |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnComponentType(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnComponentType(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnComponentType(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnComponentType(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnComponentType(Construct, String, ICfnComponentTypeProps)
public CfnComponentType(Construct scope, string id, ICfnComponentTypeProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnComponentTypeProps
Resource properties.
Properties
AttrArn
The ARN of the component type.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreationDateTime
The date and time when the component type was created.
public virtual string AttrCreationDateTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationDateTime
AttrIsAbstract
A boolean value that specifies whether the component type is abstract.
public virtual IResolvable AttrIsAbstract { get; }
Property Value
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
Remarks
CloudformationAttribute: IsSchemaInitialized
AttrStatus
public virtual IResolvable AttrStatus { get; }
Property Value
Remarks
CloudformationAttribute: Status
AttrStatusError
public virtual IResolvable AttrStatusError { get; }
Property Value
Remarks
CloudformationAttribute: Status.Error
AttrStatusErrorCode
public virtual string AttrStatusErrorCode { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status.Error.Code
AttrStatusErrorMessage
public virtual string AttrStatusErrorMessage { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status.Error.Message
AttrStatusState
public virtual string AttrStatusState { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status.State
AttrUpdateDateTime
The component type the update time.
public virtual string AttrUpdateDateTime { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ComponentTypeId
The ID of the component type.
public virtual string ComponentTypeId { get; set; }
Property Value
System.String
CompositeComponentTypes
Maps strings to compositeComponentTypes
of the componentType
.
public virtual object CompositeComponentTypes { get; set; }
Property Value
System.Object
Description
The description of the component type.
public virtual string Description { get; set; }
Property Value
System.String
ExtendsFrom
The name of the parent component type that this component type extends.
public virtual string[] ExtendsFrom { get; set; }
Property Value
System.String[]
Functions
An object that maps strings to the functions in the component type.
public virtual object Functions { get; set; }
Property Value
System.Object
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
System.Object
PropertyDefinitions
An object that maps strings to the property definitions in the component type.
public virtual object PropertyDefinitions { get; set; }
Property Value
System.Object
PropertyGroups
An object that maps strings to the property groups in the component type.
public virtual object PropertyGroups { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The ComponentType tags.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
WorkspaceId
The ID of the workspace that contains the component type.
public virtual string WorkspaceId { get; set; }
Property Value
System.String
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>