AWS Native is in preview. AWS Classic is fully supported.
aws-native.iottwinmaker.Entity
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource schema for AWS::IoTTwinMaker::Entity
Create Entity Resource
new Entity(name: string, args: EntityArgs, opts?: CustomResourceOptions);
@overload
def Entity(resource_name: str,
opts: Optional[ResourceOptions] = None,
components: Optional[Any] = None,
description: Optional[str] = None,
entity_id: Optional[str] = None,
entity_name: Optional[str] = None,
parent_entity_id: Optional[str] = None,
tags: Optional[Any] = None,
workspace_id: Optional[str] = None)
@overload
def Entity(resource_name: str,
args: EntityArgs,
opts: Optional[ResourceOptions] = None)
func NewEntity(ctx *Context, name string, args EntityArgs, opts ...ResourceOption) (*Entity, error)
public Entity(string name, EntityArgs args, CustomResourceOptions? opts = null)
public Entity(String name, EntityArgs args)
public Entity(String name, EntityArgs args, CustomResourceOptions options)
type: aws-native:iottwinmaker:Entity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EntityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EntityArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EntityArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EntityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EntityArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Entity Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Entity resource accepts the following input properties:
- Workspace
Id string The ID of the workspace.
- Components object
A map that sets information about a component type.
- Description string
The description of the entity.
- Entity
Id string The ID of the entity.
- Entity
Name string The name of the entity.
- Parent
Entity stringId The ID of the parent entity.
- object
A key-value pair to associate with a resource.
- Workspace
Id string The ID of the workspace.
- Components interface{}
A map that sets information about a component type.
- Description string
The description of the entity.
- Entity
Id string The ID of the entity.
- Entity
Name string The name of the entity.
- Parent
Entity stringId The ID of the parent entity.
- interface{}
A key-value pair to associate with a resource.
- workspace
Id String The ID of the workspace.
- components Object
A map that sets information about a component type.
- description String
The description of the entity.
- entity
Id String The ID of the entity.
- entity
Name String The name of the entity.
- parent
Entity StringId The ID of the parent entity.
- Object
A key-value pair to associate with a resource.
- workspace
Id string The ID of the workspace.
- components any
A map that sets information about a component type.
- description string
The description of the entity.
- entity
Id string The ID of the entity.
- entity
Name string The name of the entity.
- parent
Entity stringId The ID of the parent entity.
- any
A key-value pair to associate with a resource.
- workspace_
id str The ID of the workspace.
- components Any
A map that sets information about a component type.
- description str
The description of the entity.
- entity_
id str The ID of the entity.
- entity_
name str The name of the entity.
- parent_
entity_ strid The ID of the parent entity.
- Any
A key-value pair to associate with a resource.
- workspace
Id String The ID of the workspace.
- components Any
A map that sets information about a component type.
- description String
The description of the entity.
- entity
Id String The ID of the entity.
- entity
Name String The name of the entity.
- parent
Entity StringId The ID of the parent entity.
- Any
A key-value pair to associate with a resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Entity resource produces the following output properties:
- Arn string
The ARN of the entity.
- Creation
Date stringTime The date and time when the entity was created.
- Has
Child boolEntities A Boolean value that specifies whether the entity has child entities or not.
- Id string
The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Io TTwin Maker. Outputs. Entity Status The current status of the entity.
- Update
Date stringTime The last date and time when the entity was updated.
- Arn string
The ARN of the entity.
- Creation
Date stringTime The date and time when the entity was created.
- Has
Child boolEntities A Boolean value that specifies whether the entity has child entities or not.
- Id string
The provider-assigned unique ID for this managed resource.
- Status
Entity
Status The current status of the entity.
- Update
Date stringTime The last date and time when the entity was updated.
- arn String
The ARN of the entity.
- creation
Date StringTime The date and time when the entity was created.
- has
Child BooleanEntities A Boolean value that specifies whether the entity has child entities or not.
- id String
The provider-assigned unique ID for this managed resource.
- status
Entity
Status The current status of the entity.
- update
Date StringTime The last date and time when the entity was updated.
- arn string
The ARN of the entity.
- creation
Date stringTime The date and time when the entity was created.
- has
Child booleanEntities A Boolean value that specifies whether the entity has child entities or not.
- id string
The provider-assigned unique ID for this managed resource.
- status
Entity
Status The current status of the entity.
- update
Date stringTime The last date and time when the entity was updated.
- arn str
The ARN of the entity.
- creation_
date_ strtime The date and time when the entity was created.
- has_
child_ boolentities A Boolean value that specifies whether the entity has child entities or not.
- id str
The provider-assigned unique ID for this managed resource.
- status
Entity
Status The current status of the entity.
- update_
date_ strtime The last date and time when the entity was updated.
- arn String
The ARN of the entity.
- creation
Date StringTime The date and time when the entity was created.
- has
Child BooleanEntities A Boolean value that specifies whether the entity has child entities or not.
- id String
The provider-assigned unique ID for this managed resource.
- status Property Map
The current status of the entity.
- update
Date StringTime The last date and time when the entity was updated.
Supporting Types
EntityStatus, EntityStatusArgs
- Error
interface{} | Entity
Status Error Properties - State
Entity
Status State
EntityStatusErrorProperties, EntityStatusErrorPropertiesArgs
EntityStatusErrorPropertiesCode, EntityStatusErrorPropertiesCodeArgs
- Validation
Error - VALIDATION_ERROR
- Internal
Failure - INTERNAL_FAILURE
- Entity
Status Error Properties Code Validation Error - VALIDATION_ERROR
- Entity
Status Error Properties Code Internal Failure - INTERNAL_FAILURE
- Validation
Error - VALIDATION_ERROR
- Internal
Failure - INTERNAL_FAILURE
- Validation
Error - VALIDATION_ERROR
- Internal
Failure - INTERNAL_FAILURE
- VALIDATION_ERROR
- VALIDATION_ERROR
- INTERNAL_FAILURE
- INTERNAL_FAILURE
- "VALIDATION_ERROR"
- VALIDATION_ERROR
- "INTERNAL_FAILURE"
- INTERNAL_FAILURE
EntityStatusState, EntityStatusStateArgs
- Creating
- CREATING
- Updating
- UPDATING
- Deleting
- DELETING
- Active
- ACTIVE
- Error
- ERROR
- Entity
Status State Creating - CREATING
- Entity
Status State Updating - UPDATING
- Entity
Status State Deleting - DELETING
- Entity
Status State Active - ACTIVE
- Entity
Status State Error - ERROR
- Creating
- CREATING
- Updating
- UPDATING
- Deleting
- DELETING
- Active
- ACTIVE
- Error
- ERROR
- Creating
- CREATING
- Updating
- UPDATING
- Deleting
- DELETING
- Active
- ACTIVE
- Error
- ERROR
- CREATING
- CREATING
- UPDATING
- UPDATING
- DELETING
- DELETING
- ACTIVE
- ACTIVE
- ERROR
- ERROR
- "CREATING"
- CREATING
- "UPDATING"
- UPDATING
- "DELETING"
- DELETING
- "ACTIVE"
- ACTIVE
- "ERROR"
- ERROR
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.