1. Packages
  2. AWS Native
  3. API Docs
  4. iottwinmaker
  5. getComponentType

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.iottwinmaker.getComponentType

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource schema for AWS::IoTTwinMaker::ComponentType

    Using getComponentType

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getComponentType(args: GetComponentTypeArgs, opts?: InvokeOptions): Promise<GetComponentTypeResult>
    function getComponentTypeOutput(args: GetComponentTypeOutputArgs, opts?: InvokeOptions): Output<GetComponentTypeResult>
    def get_component_type(component_type_id: Optional[str] = None,
                           workspace_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetComponentTypeResult
    def get_component_type_output(component_type_id: Optional[pulumi.Input[str]] = None,
                           workspace_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetComponentTypeResult]
    func LookupComponentType(ctx *Context, args *LookupComponentTypeArgs, opts ...InvokeOption) (*LookupComponentTypeResult, error)
    func LookupComponentTypeOutput(ctx *Context, args *LookupComponentTypeOutputArgs, opts ...InvokeOption) LookupComponentTypeResultOutput

    > Note: This function is named LookupComponentType in the Go SDK.

    public static class GetComponentType 
    {
        public static Task<GetComponentTypeResult> InvokeAsync(GetComponentTypeArgs args, InvokeOptions? opts = null)
        public static Output<GetComponentTypeResult> Invoke(GetComponentTypeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetComponentTypeResult> getComponentType(GetComponentTypeArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:iottwinmaker:getComponentType
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ComponentTypeId string
    The ID of the component type.
    WorkspaceId string
    The ID of the workspace that contains the component type.
    ComponentTypeId string
    The ID of the component type.
    WorkspaceId string
    The ID of the workspace that contains the component type.
    componentTypeId String
    The ID of the component type.
    workspaceId String
    The ID of the workspace that contains the component type.
    componentTypeId string
    The ID of the component type.
    workspaceId string
    The ID of the workspace that contains the component type.
    component_type_id str
    The ID of the component type.
    workspace_id str
    The ID of the workspace that contains the component type.
    componentTypeId String
    The ID of the component type.
    workspaceId String
    The ID of the workspace that contains the component type.

    getComponentType Result

    The following output properties are available:

    Arn string
    The ARN of the component type.
    CompositeComponentTypes Dictionary<string, Pulumi.AwsNative.IoTTwinMaker.Outputs.ComponentTypeCompositeComponentType>
    An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
    CreationDateTime string
    The date and time when the component type was created.
    Description string
    The description of the component type.
    ExtendsFrom List<string>
    Specifies the parent component type to extend.
    Functions Dictionary<string, Pulumi.AwsNative.IoTTwinMaker.Outputs.ComponentTypeFunction>
    a Map of functions in the component type. Each function's key must be unique to this map.
    IsAbstract bool
    A Boolean value that specifies whether the component type is abstract.
    IsSchemaInitialized bool
    A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
    IsSingleton bool
    A Boolean value that specifies whether an entity can have more than one component of this type.
    PropertyDefinitions Dictionary<string, Pulumi.AwsNative.IoTTwinMaker.Outputs.ComponentTypePropertyDefinition>
    An map of the property definitions in the component type. Each property definition's key must be unique to this map.
    PropertyGroups Dictionary<string, Pulumi.AwsNative.IoTTwinMaker.Outputs.ComponentTypePropertyGroup>
    An map of the property groups in the component type. Each property group's key must be unique to this map.
    Status Pulumi.AwsNative.IoTTwinMaker.Outputs.ComponentTypeStatus
    The current status of the component type.
    Tags Dictionary<string, string>
    A map of key-value pairs to associate with a resource.
    UpdateDateTime string
    The last date and time when the component type was updated.
    Arn string
    The ARN of the component type.
    CompositeComponentTypes map[string]ComponentTypeCompositeComponentType
    An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
    CreationDateTime string
    The date and time when the component type was created.
    Description string
    The description of the component type.
    ExtendsFrom []string
    Specifies the parent component type to extend.
    Functions map[string]ComponentTypeFunction
    a Map of functions in the component type. Each function's key must be unique to this map.
    IsAbstract bool
    A Boolean value that specifies whether the component type is abstract.
    IsSchemaInitialized bool
    A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
    IsSingleton bool
    A Boolean value that specifies whether an entity can have more than one component of this type.
    PropertyDefinitions map[string]ComponentTypePropertyDefinition
    An map of the property definitions in the component type. Each property definition's key must be unique to this map.
    PropertyGroups map[string]ComponentTypePropertyGroup
    An map of the property groups in the component type. Each property group's key must be unique to this map.
    Status ComponentTypeStatus
    The current status of the component type.
    Tags map[string]string
    A map of key-value pairs to associate with a resource.
    UpdateDateTime string
    The last date and time when the component type was updated.
    arn String
    The ARN of the component type.
    compositeComponentTypes Map<String,ComponentTypeCompositeComponentType>
    An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
    creationDateTime String
    The date and time when the component type was created.
    description String
    The description of the component type.
    extendsFrom List<String>
    Specifies the parent component type to extend.
    functions Map<String,ComponentTypeFunction>
    a Map of functions in the component type. Each function's key must be unique to this map.
    isAbstract Boolean
    A Boolean value that specifies whether the component type is abstract.
    isSchemaInitialized Boolean
    A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
    isSingleton Boolean
    A Boolean value that specifies whether an entity can have more than one component of this type.
    propertyDefinitions Map<String,ComponentTypePropertyDefinition>
    An map of the property definitions in the component type. Each property definition's key must be unique to this map.
    propertyGroups Map<String,ComponentTypePropertyGroup>
    An map of the property groups in the component type. Each property group's key must be unique to this map.
    status ComponentTypeStatus
    The current status of the component type.
    tags Map<String,String>
    A map of key-value pairs to associate with a resource.
    updateDateTime String
    The last date and time when the component type was updated.
    arn string
    The ARN of the component type.
    compositeComponentTypes {[key: string]: ComponentTypeCompositeComponentType}
    An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
    creationDateTime string
    The date and time when the component type was created.
    description string
    The description of the component type.
    extendsFrom string[]
    Specifies the parent component type to extend.
    functions {[key: string]: ComponentTypeFunction}
    a Map of functions in the component type. Each function's key must be unique to this map.
    isAbstract boolean
    A Boolean value that specifies whether the component type is abstract.
    isSchemaInitialized boolean
    A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
    isSingleton boolean
    A Boolean value that specifies whether an entity can have more than one component of this type.
    propertyDefinitions {[key: string]: ComponentTypePropertyDefinition}
    An map of the property definitions in the component type. Each property definition's key must be unique to this map.
    propertyGroups {[key: string]: ComponentTypePropertyGroup}
    An map of the property groups in the component type. Each property group's key must be unique to this map.
    status ComponentTypeStatus
    The current status of the component type.
    tags {[key: string]: string}
    A map of key-value pairs to associate with a resource.
    updateDateTime string
    The last date and time when the component type was updated.
    arn str
    The ARN of the component type.
    composite_component_types Mapping[str, ComponentTypeCompositeComponentType]
    An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
    creation_date_time str
    The date and time when the component type was created.
    description str
    The description of the component type.
    extends_from Sequence[str]
    Specifies the parent component type to extend.
    functions Mapping[str, ComponentTypeFunction]
    a Map of functions in the component type. Each function's key must be unique to this map.
    is_abstract bool
    A Boolean value that specifies whether the component type is abstract.
    is_schema_initialized bool
    A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
    is_singleton bool
    A Boolean value that specifies whether an entity can have more than one component of this type.
    property_definitions Mapping[str, ComponentTypePropertyDefinition]
    An map of the property definitions in the component type. Each property definition's key must be unique to this map.
    property_groups Mapping[str, ComponentTypePropertyGroup]
    An map of the property groups in the component type. Each property group's key must be unique to this map.
    status ComponentTypeStatus
    The current status of the component type.
    tags Mapping[str, str]
    A map of key-value pairs to associate with a resource.
    update_date_time str
    The last date and time when the component type was updated.
    arn String
    The ARN of the component type.
    compositeComponentTypes Map<Property Map>
    An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
    creationDateTime String
    The date and time when the component type was created.
    description String
    The description of the component type.
    extendsFrom List<String>
    Specifies the parent component type to extend.
    functions Map<Property Map>
    a Map of functions in the component type. Each function's key must be unique to this map.
    isAbstract Boolean
    A Boolean value that specifies whether the component type is abstract.
    isSchemaInitialized Boolean
    A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
    isSingleton Boolean
    A Boolean value that specifies whether an entity can have more than one component of this type.
    propertyDefinitions Map<Property Map>
    An map of the property definitions in the component type. Each property definition's key must be unique to this map.
    propertyGroups Map<Property Map>
    An map of the property groups in the component type. Each property group's key must be unique to this map.
    status Property Map
    The current status of the component type.
    tags Map<String>
    A map of key-value pairs to associate with a resource.
    updateDateTime String
    The last date and time when the component type was updated.

    Supporting Types

    ComponentTypeCompositeComponentType

    ComponentTypeId string
    The id of the composite component type.
    ComponentTypeId string
    The id of the composite component type.
    componentTypeId String
    The id of the composite component type.
    componentTypeId string
    The id of the composite component type.
    component_type_id str
    The id of the composite component type.
    componentTypeId String
    The id of the composite component type.

    ComponentTypeDataConnector

    IsNative bool
    A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
    Lambda Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeLambdaFunction
    The Lambda function associated with this data connector.
    IsNative bool
    A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
    Lambda ComponentTypeLambdaFunction
    The Lambda function associated with this data connector.
    isNative Boolean
    A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
    lambda ComponentTypeLambdaFunction
    The Lambda function associated with this data connector.
    isNative boolean
    A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
    lambda ComponentTypeLambdaFunction
    The Lambda function associated with this data connector.
    is_native bool
    A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
    lambda_ ComponentTypeLambdaFunction
    The Lambda function associated with this data connector.
    isNative Boolean
    A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
    lambda Property Map
    The Lambda function associated with this data connector.

    ComponentTypeDataType

    Type Pulumi.AwsNative.IoTTwinMaker.ComponentTypeDataTypeType
    The underlying type of the data type.
    AllowedValues List<Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeDataValue>
    The allowed values for this data type.
    NestedType Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeDataType
    The nested type in the data type.
    Relationship Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeRelationship
    A relationship that associates a component with another component.
    UnitOfMeasure string
    The unit of measure used in this data type.
    Type ComponentTypeDataTypeType
    The underlying type of the data type.
    AllowedValues []ComponentTypeDataValue
    The allowed values for this data type.
    NestedType ComponentTypeDataType
    The nested type in the data type.
    Relationship ComponentTypeRelationship
    A relationship that associates a component with another component.
    UnitOfMeasure string
    The unit of measure used in this data type.
    type ComponentTypeDataTypeType
    The underlying type of the data type.
    allowedValues List<ComponentTypeDataValue>
    The allowed values for this data type.
    nestedType ComponentTypeDataType
    The nested type in the data type.
    relationship ComponentTypeRelationship
    A relationship that associates a component with another component.
    unitOfMeasure String
    The unit of measure used in this data type.
    type ComponentTypeDataTypeType
    The underlying type of the data type.
    allowedValues ComponentTypeDataValue[]
    The allowed values for this data type.
    nestedType ComponentTypeDataType
    The nested type in the data type.
    relationship ComponentTypeRelationship
    A relationship that associates a component with another component.
    unitOfMeasure string
    The unit of measure used in this data type.
    type ComponentTypeDataTypeType
    The underlying type of the data type.
    allowed_values Sequence[ComponentTypeDataValue]
    The allowed values for this data type.
    nested_type ComponentTypeDataType
    The nested type in the data type.
    relationship ComponentTypeRelationship
    A relationship that associates a component with another component.
    unit_of_measure str
    The unit of measure used in this data type.
    type "RELATIONSHIP" | "STRING" | "LONG" | "BOOLEAN" | "INTEGER" | "DOUBLE" | "LIST" | "MAP"
    The underlying type of the data type.
    allowedValues List<Property Map>
    The allowed values for this data type.
    nestedType Property Map
    The nested type in the data type.
    relationship Property Map
    A relationship that associates a component with another component.
    unitOfMeasure String
    The unit of measure used in this data type.

    ComponentTypeDataTypeType

    ComponentTypeDataValue

    BooleanValue bool
    A Boolean value.
    DoubleValue double
    A double value.
    Expression string
    An expression that produces the value.
    IntegerValue int
    An integer value.
    ListValue List<Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeDataValue>
    A list of multiple values.
    LongValue double
    A long value.
    MapValue Dictionary<string, Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeDataValue>
    An object that maps strings to multiple DataValue objects.
    RelationshipValue Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeDataValueRelationshipValueProperties
    A value that relates a component to another component.
    StringValue string
    A string value.
    BooleanValue bool
    A Boolean value.
    DoubleValue float64
    A double value.
    Expression string
    An expression that produces the value.
    IntegerValue int
    An integer value.
    ListValue []ComponentTypeDataValue
    A list of multiple values.
    LongValue float64
    A long value.
    MapValue map[string]ComponentTypeDataValue
    An object that maps strings to multiple DataValue objects.
    RelationshipValue ComponentTypeDataValueRelationshipValueProperties
    A value that relates a component to another component.
    StringValue string
    A string value.
    booleanValue Boolean
    A Boolean value.
    doubleValue Double
    A double value.
    expression String
    An expression that produces the value.
    integerValue Integer
    An integer value.
    listValue List<ComponentTypeDataValue>
    A list of multiple values.
    longValue Double
    A long value.
    mapValue Map<String,ComponentTypeDataValue>
    An object that maps strings to multiple DataValue objects.
    relationshipValue ComponentTypeDataValueRelationshipValueProperties
    A value that relates a component to another component.
    stringValue String
    A string value.
    booleanValue boolean
    A Boolean value.
    doubleValue number
    A double value.
    expression string
    An expression that produces the value.
    integerValue number
    An integer value.
    listValue ComponentTypeDataValue[]
    A list of multiple values.
    longValue number
    A long value.
    mapValue {[key: string]: ComponentTypeDataValue}
    An object that maps strings to multiple DataValue objects.
    relationshipValue ComponentTypeDataValueRelationshipValueProperties
    A value that relates a component to another component.
    stringValue string
    A string value.
    boolean_value bool
    A Boolean value.
    double_value float
    A double value.
    expression str
    An expression that produces the value.
    integer_value int
    An integer value.
    list_value Sequence[ComponentTypeDataValue]
    A list of multiple values.
    long_value float
    A long value.
    map_value Mapping[str, ComponentTypeDataValue]
    An object that maps strings to multiple DataValue objects.
    relationship_value ComponentTypeDataValueRelationshipValueProperties
    A value that relates a component to another component.
    string_value str
    A string value.
    booleanValue Boolean
    A Boolean value.
    doubleValue Number
    A double value.
    expression String
    An expression that produces the value.
    integerValue Number
    An integer value.
    listValue List<Property Map>
    A list of multiple values.
    longValue Number
    A long value.
    mapValue Map<Property Map>
    An object that maps strings to multiple DataValue objects.
    relationshipValue Property Map
    A value that relates a component to another component.
    stringValue String
    A string value.

    ComponentTypeDataValueRelationshipValueProperties

    ComponentTypeFunction

    ImplementedBy ComponentTypeDataConnector
    The data connector.
    RequiredProperties []string
    The required properties of the function.
    Scope ComponentTypeFunctionScope
    The scope of the function.
    implementedBy ComponentTypeDataConnector
    The data connector.
    requiredProperties List<String>
    The required properties of the function.
    scope ComponentTypeFunctionScope
    The scope of the function.
    implementedBy ComponentTypeDataConnector
    The data connector.
    requiredProperties string[]
    The required properties of the function.
    scope ComponentTypeFunctionScope
    The scope of the function.
    implemented_by ComponentTypeDataConnector
    The data connector.
    required_properties Sequence[str]
    The required properties of the function.
    scope ComponentTypeFunctionScope
    The scope of the function.
    implementedBy Property Map
    The data connector.
    requiredProperties List<String>
    The required properties of the function.
    scope "ENTITY" | "WORKSPACE"
    The scope of the function.

    ComponentTypeFunctionScope

    ComponentTypeLambdaFunction

    Arn string
    Arn string
    arn String
    arn string
    arn str
    arn String

    ComponentTypePropertyDefinition

    Configurations Dictionary<string, string>
    An object that specifies information about a property.
    DataType Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeDataType
    An object that contains information about the data type.
    DefaultValue Pulumi.AwsNative.IoTTwinMaker.Inputs.ComponentTypeDataValue
    An object that contains the default value.
    IsExternalId bool
    A Boolean value that specifies whether the property ID comes from an external data store.
    IsRequiredInEntity bool
    A Boolean value that specifies whether the property is required.
    IsStoredExternally bool
    A Boolean value that specifies whether the property is stored externally.
    IsTimeSeries bool
    A Boolean value that specifies whether the property consists of time series data.
    Configurations map[string]string
    An object that specifies information about a property.
    DataType ComponentTypeDataType
    An object that contains information about the data type.
    DefaultValue ComponentTypeDataValue
    An object that contains the default value.
    IsExternalId bool
    A Boolean value that specifies whether the property ID comes from an external data store.
    IsRequiredInEntity bool
    A Boolean value that specifies whether the property is required.
    IsStoredExternally bool
    A Boolean value that specifies whether the property is stored externally.
    IsTimeSeries bool
    A Boolean value that specifies whether the property consists of time series data.
    configurations Map<String,String>
    An object that specifies information about a property.
    dataType ComponentTypeDataType
    An object that contains information about the data type.
    defaultValue ComponentTypeDataValue
    An object that contains the default value.
    isExternalId Boolean
    A Boolean value that specifies whether the property ID comes from an external data store.
    isRequiredInEntity Boolean
    A Boolean value that specifies whether the property is required.
    isStoredExternally Boolean
    A Boolean value that specifies whether the property is stored externally.
    isTimeSeries Boolean
    A Boolean value that specifies whether the property consists of time series data.
    configurations {[key: string]: string}
    An object that specifies information about a property.
    dataType ComponentTypeDataType
    An object that contains information about the data type.
    defaultValue ComponentTypeDataValue
    An object that contains the default value.
    isExternalId boolean
    A Boolean value that specifies whether the property ID comes from an external data store.
    isRequiredInEntity boolean
    A Boolean value that specifies whether the property is required.
    isStoredExternally boolean
    A Boolean value that specifies whether the property is stored externally.
    isTimeSeries boolean
    A Boolean value that specifies whether the property consists of time series data.
    configurations Mapping[str, str]
    An object that specifies information about a property.
    data_type ComponentTypeDataType
    An object that contains information about the data type.
    default_value ComponentTypeDataValue
    An object that contains the default value.
    is_external_id bool
    A Boolean value that specifies whether the property ID comes from an external data store.
    is_required_in_entity bool
    A Boolean value that specifies whether the property is required.
    is_stored_externally bool
    A Boolean value that specifies whether the property is stored externally.
    is_time_series bool
    A Boolean value that specifies whether the property consists of time series data.
    configurations Map<String>
    An object that specifies information about a property.
    dataType Property Map
    An object that contains information about the data type.
    defaultValue Property Map
    An object that contains the default value.
    isExternalId Boolean
    A Boolean value that specifies whether the property ID comes from an external data store.
    isRequiredInEntity Boolean
    A Boolean value that specifies whether the property is required.
    isStoredExternally Boolean
    A Boolean value that specifies whether the property is stored externally.
    isTimeSeries Boolean
    A Boolean value that specifies whether the property consists of time series data.

    ComponentTypePropertyGroup

    GroupType Pulumi.AwsNative.IoTTwinMaker.ComponentTypePropertyGroupGroupType
    The type of property group.
    PropertyNames List<string>
    The list of property names in the property group.
    GroupType ComponentTypePropertyGroupGroupType
    The type of property group.
    PropertyNames []string
    The list of property names in the property group.
    groupType ComponentTypePropertyGroupGroupType
    The type of property group.
    propertyNames List<String>
    The list of property names in the property group.
    groupType ComponentTypePropertyGroupGroupType
    The type of property group.
    propertyNames string[]
    The list of property names in the property group.
    group_type ComponentTypePropertyGroupGroupType
    The type of property group.
    property_names Sequence[str]
    The list of property names in the property group.
    groupType "TABULAR"
    The type of property group.
    propertyNames List<String>
    The list of property names in the property group.

    ComponentTypePropertyGroupGroupType

    ComponentTypeRelationship

    RelationshipType string
    The type of the relationship.
    TargetComponentTypeId string
    The ID of the target component type associated with this relationship.
    RelationshipType string
    The type of the relationship.
    TargetComponentTypeId string
    The ID of the target component type associated with this relationship.
    relationshipType String
    The type of the relationship.
    targetComponentTypeId String
    The ID of the target component type associated with this relationship.
    relationshipType string
    The type of the relationship.
    targetComponentTypeId string
    The ID of the target component type associated with this relationship.
    relationship_type str
    The type of the relationship.
    target_component_type_id str
    The ID of the target component type associated with this relationship.
    relationshipType String
    The type of the relationship.
    targetComponentTypeId String
    The ID of the target component type associated with this relationship.

    ComponentTypeStatus

    ComponentTypeStatusErrorProperties

    ComponentTypeStatusErrorPropertiesCode

    ComponentTypeStatusState

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi