Entity

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:

WorkspaceId string

The ID of the workspace.

Components object

A map that sets information about a component type.

Description string

The description of the entity.

EntityId string

The ID of the entity.

EntityName string

The name of the entity.

ParentEntityId string

The ID of the parent entity.

Tags object

A key-value pair to associate with a resource.

WorkspaceId string

The ID of the workspace.

Components interface{}

A map that sets information about a component type.

Description string

The description of the entity.

EntityId string

The ID of the entity.

EntityName string

The name of the entity.

ParentEntityId string

The ID of the parent entity.

Tags interface{}

A key-value pair to associate with a resource.

workspaceId String

The ID of the workspace.

components Object

A map that sets information about a component type.

description String

The description of the entity.

entityId String

The ID of the entity.

entityName String

The name of the entity.

parentEntityId String

The ID of the parent entity.

tags Object

A key-value pair to associate with a resource.

workspaceId string

The ID of the workspace.

components any

A map that sets information about a component type.

description string

The description of the entity.

entityId string

The ID of the entity.

entityName string

The name of the entity.

parentEntityId string

The ID of the parent entity.

tags 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_id str

The ID of the parent entity.

tags Any

A key-value pair to associate with a resource.

workspaceId String

The ID of the workspace.

components Any

A map that sets information about a component type.

description String

The description of the entity.

entityId String

The ID of the entity.

entityName String

The name of the entity.

parentEntityId String

The ID of the parent entity.

tags 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.

CreationDateTime string

The date and time when the entity was created.

HasChildEntities bool

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.AwsNative.IoTTwinMaker.Outputs.EntityStatus

The current status of the entity.

UpdateDateTime string

The last date and time when the entity was updated.

Arn string

The ARN of the entity.

CreationDateTime string

The date and time when the entity was created.

HasChildEntities bool

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 EntityStatus

The current status of the entity.

UpdateDateTime string

The last date and time when the entity was updated.

arn String

The ARN of the entity.

creationDateTime String

The date and time when the entity was created.

hasChildEntities Boolean

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 EntityStatus

The current status of the entity.

updateDateTime String

The last date and time when the entity was updated.

arn string

The ARN of the entity.

creationDateTime string

The date and time when the entity was created.

hasChildEntities boolean

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 EntityStatus

The current status of the entity.

updateDateTime string

The last date and time when the entity was updated.

arn str

The ARN of the entity.

creation_date_time str

The date and time when the entity was created.

has_child_entities bool

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 EntityStatus

The current status of the entity.

update_date_time str

The last date and time when the entity was updated.

arn String

The ARN of the entity.

creationDateTime String

The date and time when the entity was created.

hasChildEntities Boolean

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.

updateDateTime String

The last date and time when the entity was updated.

Supporting Types

EntityStatus

EntityStatusErrorProperties

EntityStatusErrorPropertiesCode

ValidationError
VALIDATION_ERROR
InternalFailure
INTERNAL_FAILURE
EntityStatusErrorPropertiesCodeValidationError
VALIDATION_ERROR
EntityStatusErrorPropertiesCodeInternalFailure
INTERNAL_FAILURE
ValidationError
VALIDATION_ERROR
InternalFailure
INTERNAL_FAILURE
ValidationError
VALIDATION_ERROR
InternalFailure
INTERNAL_FAILURE
VALIDATION_ERROR
VALIDATION_ERROR
INTERNAL_FAILURE
INTERNAL_FAILURE
"VALIDATION_ERROR"
VALIDATION_ERROR
"INTERNAL_FAILURE"
INTERNAL_FAILURE

EntityStatusState

Creating
CREATING
Updating
UPDATING
Deleting
DELETING
Active
ACTIVE
Error
ERROR
EntityStatusStateCreating
CREATING
EntityStatusStateUpdating
UPDATING
EntityStatusStateDeleting
DELETING
EntityStatusStateActive
ACTIVE
EntityStatusStateError
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
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0