Class CfnComponentType
A CloudFormation AWS::IoTTwinMaker::ComponentType
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTTwinMaker
Assembly: Amazon.CDK.AWS.IoTTwinMaker.dll
Syntax (csharp)
public class CfnComponentType : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnComponentType
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Use the AWS::IoTTwinMaker::ComponentType
resource to declare a component type.
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
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 |
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 |
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. |
AttrStatusErrorCode | component type error code. |
AttrStatusErrorMessage | The component type error message. |
AttrStatusState | The component type state. |
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. |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnComponentTypeProps
- resource properties.
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
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
AttrStatusErrorCode
component type error code.
public virtual string AttrStatusErrorCode { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status.Error.Code
AttrStatusErrorMessage
The component type error message.
public virtual string AttrStatusErrorMessage { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status.Error.Message
AttrStatusState
The component type state.
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
Remarks
Description
The description of the component type.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
ExtendsFrom
The name of the parent component type that this component type extends.
public virtual string[] ExtendsFrom { get; set; }
Property Value
System.String[]
Remarks
Functions
An object that maps strings to the functions in the component type.
public virtual object Functions { get; set; }
Property Value
System.Object
Remarks
Each string in the mapping must be unique to this object.
For information on the FunctionResponse object see the FunctionResponse API reference.
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
Remarks
PropertyDefinitions
An object that maps strings to the property definitions in the component type.
public virtual object PropertyDefinitions { get; set; }
Property Value
System.Object
Remarks
Each string in the mapping must be unique to this object.
For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.
PropertyGroups
An object that maps strings to the property groups in the component type.
public virtual object PropertyGroups { get; set; }
Property Value
System.Object
Remarks
Each string in the mapping must be unique to this object.
Tags
The ComponentType tags.
public virtual TagManager Tags { get; }
Property Value
Remarks
WorkspaceId
The ID of the workspace.
public virtual string WorkspaceId { get; set; }
Property Value
System.String
Remarks
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>