AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
aws-native.iottwinmaker.getComponentType
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 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:
- Component
Type stringId - The ID of the component type.
- Workspace
Id string - The ID of the workspace that contains the component type.
- Component
Type stringId - The ID of the component type.
- Workspace
Id string - The ID of the workspace that contains the component type.
- component
Type StringId - The ID of the component type.
- workspace
Id String - The ID of the workspace that contains the component type.
- component
Type stringId - The ID of the component type.
- workspace
Id string - The ID of the workspace that contains the component type.
- component_
type_ strid - The ID of the component type.
- workspace_
id str - The ID of the workspace that contains the component type.
- component
Type StringId - The ID of the component type.
- workspace
Id 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.
- Composite
Component Dictionary<string, Pulumi.Types Aws Native. Io TTwin Maker. Outputs. Component Type Composite Component Type> - 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 stringTime - The date and time when the component type was created.
- Description string
- The description of the component type.
- Extends
From List<string> - Specifies the parent component type to extend.
- Functions
Dictionary<string, Pulumi.
Aws Native. Io TTwin Maker. Outputs. Component Type Function> - 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 boolInitialized - 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 Dictionary<string, Pulumi.Aws Native. Io TTwin Maker. Outputs. Component Type Property Definition> - An map of the property definitions in the component type. Each property definition's key must be unique to this map.
- Property
Groups Dictionary<string, Pulumi.Aws Native. Io TTwin Maker. Outputs. Component Type Property Group> - An map of the property groups in the component type. Each property group's key must be unique to this map.
- Status
Pulumi.
Aws Native. Io TTwin Maker. Outputs. Component Type Status - The current status of the component type.
- Dictionary<string, string>
- A map of key-value pairs to associate with a resource.
- Update
Date stringTime - The last date and time when the component type was updated.
- Arn string
- The ARN of the component type.
- Composite
Component map[string]ComponentTypes Type Composite Component Type - 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 stringTime - The date and time when the component type was created.
- Description string
- The description of the component type.
- Extends
From []string - Specifies the parent component type to extend.
- Functions
map[string]Component
Type Function - 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 boolInitialized - 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 map[string]ComponentType Property Definition - An map of the property definitions in the component type. Each property definition's key must be unique to this map.
- Property
Groups map[string]ComponentType Property Group - An map of the property groups in the component type. Each property group's key must be unique to this map.
- Status
Component
Type Status - The current status of the component type.
- map[string]string
- A map of key-value pairs to associate with a resource.
- Update
Date stringTime - The last date and time when the component type was updated.
- arn String
- The ARN of the component type.
- composite
Component Map<String,ComponentTypes Type Composite Component Type> - 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 StringTime - The date and time when the component type was created.
- description String
- The description of the component type.
- extends
From List<String> - Specifies the parent component type to extend.
- functions
Map<String,Component
Type Function> - a Map of functions in the component type. Each function's key must be unique to this map.
- is
Abstract Boolean - A Boolean value that specifies whether the component type is abstract.
- is
Schema BooleanInitialized - A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
- is
Singleton Boolean - A Boolean value that specifies whether an entity can have more than one component of this type.
- property
Definitions Map<String,ComponentType Property Definition> - An map of the property definitions in the component type. Each property definition's key must be unique to this map.
- property
Groups Map<String,ComponentType Property Group> - An map of the property groups in the component type. Each property group's key must be unique to this map.
- status
Component
Type Status - The current status of the component type.
- Map<String,String>
- A map of key-value pairs to associate with a resource.
- update
Date StringTime - The last date and time when the component type was updated.
- arn string
- The ARN of the component type.
- composite
Component {[key: string]: ComponentTypes Type Composite Component Type} - 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 stringTime - The date and time when the component type was created.
- description string
- The description of the component type.
- extends
From string[] - Specifies the parent component type to extend.
- functions
{[key: string]: Component
Type Function} - a Map of functions in the component type. Each function's key must be unique to this map.
- is
Abstract boolean - A Boolean value that specifies whether the component type is abstract.
- is
Schema booleanInitialized - A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
- is
Singleton boolean - A Boolean value that specifies whether an entity can have more than one component of this type.
- property
Definitions {[key: string]: ComponentType Property Definition} - An map of the property definitions in the component type. Each property definition's key must be unique to this map.
- property
Groups {[key: string]: ComponentType Property Group} - An map of the property groups in the component type. Each property group's key must be unique to this map.
- status
Component
Type Status - The current status of the component type.
- {[key: string]: string}
- A map of key-value pairs to associate with a resource.
- update
Date stringTime - The last date and time when the component type was updated.
- arn str
- The ARN of the component type.
- composite_
component_ Mapping[str, Componenttypes Type Composite Component Type] - 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_ strtime - 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, Component
Type Function] - 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_ boolinitialized - 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, ComponentType Property Definition] - 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, ComponentType Property Group] - An map of the property groups in the component type. Each property group's key must be unique to this map.
- status
Component
Type Status - The current status of the component type.
- Mapping[str, str]
- A map of key-value pairs to associate with a resource.
- update_
date_ strtime - The last date and time when the component type was updated.
- arn String
- The ARN of the component type.
- composite
Component Map<Property Map>Types - 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 StringTime - The date and time when the component type was created.
- description String
- The description of the component type.
- extends
From 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.
- is
Abstract Boolean - A Boolean value that specifies whether the component type is abstract.
- is
Schema BooleanInitialized - A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
- is
Singleton Boolean - A Boolean value that specifies whether an entity can have more than one component of this type.
- property
Definitions Map<Property Map> - An map of the property definitions in the component type. Each property definition's key must be unique to this map.
- property
Groups 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.
- Map<String>
- A map of key-value pairs to associate with a resource.
- update
Date StringTime - The last date and time when the component type was updated.
Supporting Types
ComponentTypeCompositeComponentType
- Component
Type stringId - The id of the composite component type.
- Component
Type stringId - The id of the composite component type.
- component
Type StringId - The id of the composite component type.
- component
Type stringId - The id of the composite component type.
- component_
type_ strid - The id of the composite component type.
- component
Type StringId - The id of the composite component type.
ComponentTypeDataConnector
- Is
Native bool - A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
- Lambda
Pulumi.
Aws Native. Io TTwin Maker. Inputs. Component Type Lambda Function - 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
Component
Type Lambda Function - The Lambda function associated with this data connector.
- is
Native Boolean - A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
- lambda
Component
Type Lambda Function - The Lambda function associated with this data connector.
- is
Native boolean - A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
- lambda
Component
Type Lambda Function - 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_
Component
Type Lambda Function - The Lambda function associated with this data connector.
- is
Native 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.
Aws Native. Io TTwin Maker. Component Type Data Type Type - The underlying type of the data type.
- Allowed
Values List<Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Value> - The allowed values for this data type.
- Nested
Type Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Type - The nested type in the data type.
- Relationship
Pulumi.
Aws Native. Io TTwin Maker. Inputs. Component Type Relationship - A relationship that associates a component with another component.
- Unit
Of stringMeasure - The unit of measure used in this data type.
- Type
Component
Type Data Type Type - The underlying type of the data type.
- Allowed
Values []ComponentType Data Value - The allowed values for this data type.
- Nested
Type ComponentType Data Type - The nested type in the data type.
- Relationship
Component
Type Relationship - A relationship that associates a component with another component.
- Unit
Of stringMeasure - The unit of measure used in this data type.
- type
Component
Type Data Type Type - The underlying type of the data type.
- allowed
Values List<ComponentType Data Value> - The allowed values for this data type.
- nested
Type ComponentType Data Type - The nested type in the data type.
- relationship
Component
Type Relationship - A relationship that associates a component with another component.
- unit
Of StringMeasure - The unit of measure used in this data type.
- type
Component
Type Data Type Type - The underlying type of the data type.
- allowed
Values ComponentType Data Value[] - The allowed values for this data type.
- nested
Type ComponentType Data Type - The nested type in the data type.
- relationship
Component
Type Relationship - A relationship that associates a component with another component.
- unit
Of stringMeasure - The unit of measure used in this data type.
- type
Component
Type Data Type Type - The underlying type of the data type.
- allowed_
values Sequence[ComponentType Data Value] - The allowed values for this data type.
- nested_
type ComponentType Data Type - The nested type in the data type.
- relationship
Component
Type Relationship - A relationship that associates a component with another component.
- unit_
of_ strmeasure - 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.
- allowed
Values List<Property Map> - The allowed values for this data type.
- nested
Type Property Map - The nested type in the data type.
- relationship Property Map
- A relationship that associates a component with another component.
- unit
Of StringMeasure - The unit of measure used in this data type.
ComponentTypeDataTypeType
ComponentTypeDataValue
- Boolean
Value bool - A Boolean value.
- Double
Value double - A double value.
- Expression string
- An expression that produces the value.
- Integer
Value int - An integer value.
- List
Value List<Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Value> - A list of multiple values.
- Long
Value double - A long value.
- Map
Value Dictionary<string, Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Value> - An object that maps strings to multiple DataValue objects.
- Relationship
Value Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Value Relationship Value Properties - A value that relates a component to another component.
- String
Value string - A string value.
- Boolean
Value bool - A Boolean value.
- Double
Value float64 - A double value.
- Expression string
- An expression that produces the value.
- Integer
Value int - An integer value.
- List
Value []ComponentType Data Value - A list of multiple values.
- Long
Value float64 - A long value.
- Map
Value map[string]ComponentType Data Value - An object that maps strings to multiple DataValue objects.
- Relationship
Value ComponentType Data Value Relationship Value Properties - A value that relates a component to another component.
- String
Value string - A string value.
- boolean
Value Boolean - A Boolean value.
- double
Value Double - A double value.
- expression String
- An expression that produces the value.
- integer
Value Integer - An integer value.
- list
Value List<ComponentType Data Value> - A list of multiple values.
- long
Value Double - A long value.
- map
Value Map<String,ComponentType Data Value> - An object that maps strings to multiple DataValue objects.
- relationship
Value ComponentType Data Value Relationship Value Properties - A value that relates a component to another component.
- string
Value String - A string value.
- boolean
Value boolean - A Boolean value.
- double
Value number - A double value.
- expression string
- An expression that produces the value.
- integer
Value number - An integer value.
- list
Value ComponentType Data Value[] - A list of multiple values.
- long
Value number - A long value.
- map
Value {[key: string]: ComponentType Data Value} - An object that maps strings to multiple DataValue objects.
- relationship
Value ComponentType Data Value Relationship Value Properties - A value that relates a component to another component.
- string
Value 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[ComponentType Data Value] - A list of multiple values.
- long_
value float - A long value.
- map_
value Mapping[str, ComponentType Data Value] - An object that maps strings to multiple DataValue objects.
- relationship_
value ComponentType Data Value Relationship Value Properties - A value that relates a component to another component.
- string_
value str - A string value.
- boolean
Value Boolean - A Boolean value.
- double
Value Number - A double value.
- expression String
- An expression that produces the value.
- integer
Value Number - An integer value.
- list
Value List<Property Map> - A list of multiple values.
- long
Value Number - A long value.
- map
Value Map<Property Map> - An object that maps strings to multiple DataValue objects.
- relationship
Value Property Map - A value that relates a component to another component.
- string
Value String - A string value.
ComponentTypeDataValueRelationshipValueProperties
- Target
Component stringName - Target
Entity stringId
- Target
Component stringName - Target
Entity stringId
- target
Component StringName - target
Entity StringId
- target
Component stringName - target
Entity stringId
- target
Component StringName - target
Entity StringId
ComponentTypeFunction
- Implemented
By Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Connector - The data connector.
- Required
Properties List<string> - The required properties of the function.
- Scope
Pulumi.
Aws Native. Io TTwin Maker. Component Type Function Scope - The scope of the function.
- Implemented
By ComponentType Data Connector - The data connector.
- Required
Properties []string - The required properties of the function.
- Scope
Component
Type Function Scope - The scope of the function.
- implemented
By ComponentType Data Connector - The data connector.
- required
Properties List<String> - The required properties of the function.
- scope
Component
Type Function Scope - The scope of the function.
- implemented
By ComponentType Data Connector - The data connector.
- required
Properties string[] - The required properties of the function.
- scope
Component
Type Function Scope - The scope of the function.
- implemented_
by ComponentType Data Connector - The data connector.
- required_
properties Sequence[str] - The required properties of the function.
- scope
Component
Type Function Scope - The scope of the function.
- implemented
By Property Map - The data connector.
- required
Properties 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.
- Data
Type Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Type - An object that contains information about the data type.
- Default
Value Pulumi.Aws Native. Io TTwin Maker. Inputs. Component Type Data Value - An object that contains the default value.
- Is
External boolId - A Boolean value that specifies whether the property ID comes from an external data store.
- Is
Required boolIn Entity - A Boolean value that specifies whether the property is required.
- Is
Stored boolExternally - A Boolean value that specifies whether the property is stored externally.
- Is
Time boolSeries - 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.
- Data
Type ComponentType Data Type - An object that contains information about the data type.
- Default
Value ComponentType Data Value - An object that contains the default value.
- Is
External boolId - A Boolean value that specifies whether the property ID comes from an external data store.
- Is
Required boolIn Entity - A Boolean value that specifies whether the property is required.
- Is
Stored boolExternally - A Boolean value that specifies whether the property is stored externally.
- Is
Time boolSeries - 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.
- data
Type ComponentType Data Type - An object that contains information about the data type.
- default
Value ComponentType Data Value - An object that contains the default value.
- is
External BooleanId - A Boolean value that specifies whether the property ID comes from an external data store.
- is
Required BooleanIn Entity - A Boolean value that specifies whether the property is required.
- is
Stored BooleanExternally - A Boolean value that specifies whether the property is stored externally.
- is
Time BooleanSeries - 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.
- data
Type ComponentType Data Type - An object that contains information about the data type.
- default
Value ComponentType Data Value - An object that contains the default value.
- is
External booleanId - A Boolean value that specifies whether the property ID comes from an external data store.
- is
Required booleanIn Entity - A Boolean value that specifies whether the property is required.
- is
Stored booleanExternally - A Boolean value that specifies whether the property is stored externally.
- is
Time booleanSeries - 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 ComponentType Data Type - An object that contains information about the data type.
- default_
value ComponentType Data Value - An object that contains the default value.
- is_
external_ boolid - A Boolean value that specifies whether the property ID comes from an external data store.
- is_
required_ boolin_ entity - A Boolean value that specifies whether the property is required.
- is_
stored_ boolexternally - A Boolean value that specifies whether the property is stored externally.
- is_
time_ boolseries - A Boolean value that specifies whether the property consists of time series data.
- configurations Map<String>
- An object that specifies information about a property.
- data
Type Property Map - An object that contains information about the data type.
- default
Value Property Map - An object that contains the default value.
- is
External BooleanId - A Boolean value that specifies whether the property ID comes from an external data store.
- is
Required BooleanIn Entity - A Boolean value that specifies whether the property is required.
- is
Stored BooleanExternally - A Boolean value that specifies whether the property is stored externally.
- is
Time BooleanSeries - A Boolean value that specifies whether the property consists of time series data.
ComponentTypePropertyGroup
- Group
Type Pulumi.Aws Native. Io TTwin Maker. Component Type Property Group Group Type - The type of property group.
- Property
Names List<string> - The list of property names in the property group.
- Group
Type ComponentType Property Group Group Type - The type of property group.
- Property
Names []string - The list of property names in the property group.
- group
Type ComponentType Property Group Group Type - The type of property group.
- property
Names List<String> - The list of property names in the property group.
- group
Type ComponentType Property Group Group Type - The type of property group.
- property
Names string[] - The list of property names in the property group.
- group_
type ComponentType Property Group Group Type - The type of property group.
- property_
names Sequence[str] - The list of property names in the property group.
- group
Type "TABULAR" - The type of property group.
- property
Names List<String> - The list of property names in the property group.
ComponentTypePropertyGroupGroupType
ComponentTypeRelationship
- Relationship
Type string - The type of the relationship.
- Target
Component stringType Id - The ID of the target component type associated with this relationship.
- Relationship
Type string - The type of the relationship.
- Target
Component stringType Id - The ID of the target component type associated with this relationship.
- relationship
Type String - The type of the relationship.
- target
Component StringType Id - The ID of the target component type associated with this relationship.
- relationship
Type string - The type of the relationship.
- target
Component stringType Id - The ID of the target component type associated with this relationship.
- relationship_
type str - The type of the relationship.
- target_
component_ strtype_ id - The ID of the target component type associated with this relationship.
- relationship
Type String - The type of the relationship.
- target
Component StringType Id - The ID of the target component type associated with this relationship.
ComponentTypeStatus
- Error
object | Pulumi.
Aws Native. Io TTwin Maker. Inputs. Component Type Status Error Properties - The component type error.
- State
Pulumi.
Aws Native. Io TTwin Maker. Component Type Status State - The component type status state.
- Error
interface{} | Component
Type Status Error Properties - The component type error.
- State
Component
Type Status State - The component type status state.
- error
Object | Component
Type Status Error Properties - The component type error.
- state
Component
Type Status State - The component type status state.
- error
any | Component
Type Status Error Properties - The component type error.
- state
Component
Type Status State - The component type status state.
- error
Any | Component
Type Status Error Properties - The component type error.
- state
Component
Type Status State - The component type status state.
- error Any | Property Map
- The component type error.
- state "CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "ERROR"
- The component type status state.
ComponentTypeStatusErrorProperties
ComponentTypeStatusErrorPropertiesCode
ComponentTypeStatusState
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi