Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotsitewise
  5. Asset

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotsitewise.Asset

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::IoTSiteWise::Asset

Create Asset Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Asset(name: string, args: AssetArgs, opts?: CustomResourceOptions);
@overload
def Asset(resource_name: str,
          args: AssetArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Asset(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          asset_model_id: Optional[str] = None,
          asset_description: Optional[str] = None,
          asset_external_id: Optional[str] = None,
          asset_hierarchies: Optional[Sequence[AssetHierarchyArgs]] = None,
          asset_name: Optional[str] = None,
          asset_properties: Optional[Sequence[AssetPropertyArgs]] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewAsset(ctx *Context, name string, args AssetArgs, opts ...ResourceOption) (*Asset, error)
public Asset(string name, AssetArgs args, CustomResourceOptions? opts = null)
public Asset(String name, AssetArgs args)
public Asset(String name, AssetArgs args, CustomResourceOptions options)

type: aws-native:iotsitewise:Asset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AssetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AssetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AssetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AssetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AssetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Asset Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Asset resource accepts the following input properties:

AssetModelId This property is required. string
The ID of the asset model from which to create the asset.
AssetDescription string
A description for the asset
AssetExternalId string
The External ID of the asset
AssetHierarchies List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetHierarchy>
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
AssetName string
A unique, friendly name for the asset.
AssetProperties List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetProperty>

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

Tags List<Pulumi.AwsNative.Inputs.Tag>
A list of key-value pairs that contain metadata for the asset.
AssetModelId This property is required. string
The ID of the asset model from which to create the asset.
AssetDescription string
A description for the asset
AssetExternalId string
The External ID of the asset
AssetHierarchies []AssetHierarchyArgs
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
AssetName string
A unique, friendly name for the asset.
AssetProperties []AssetPropertyArgs

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

Tags TagArgs
A list of key-value pairs that contain metadata for the asset.
assetModelId This property is required. String
The ID of the asset model from which to create the asset.
assetDescription String
A description for the asset
assetExternalId String
The External ID of the asset
assetHierarchies List<AssetHierarchy>
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
assetName String
A unique, friendly name for the asset.
assetProperties List<AssetProperty>

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

tags List<Tag>
A list of key-value pairs that contain metadata for the asset.
assetModelId This property is required. string
The ID of the asset model from which to create the asset.
assetDescription string
A description for the asset
assetExternalId string
The External ID of the asset
assetHierarchies AssetHierarchy[]
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
assetName string
A unique, friendly name for the asset.
assetProperties AssetProperty[]

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

tags Tag[]
A list of key-value pairs that contain metadata for the asset.
asset_model_id This property is required. str
The ID of the asset model from which to create the asset.
asset_description str
A description for the asset
asset_external_id str
The External ID of the asset
asset_hierarchies Sequence[AssetHierarchyArgs]
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
asset_name str
A unique, friendly name for the asset.
asset_properties Sequence[AssetPropertyArgs]

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

tags Sequence[TagArgs]
A list of key-value pairs that contain metadata for the asset.
assetModelId This property is required. String
The ID of the asset model from which to create the asset.
assetDescription String
A description for the asset
assetExternalId String
The External ID of the asset
assetHierarchies List<Property Map>
A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
assetName String
A unique, friendly name for the asset.
assetProperties List<Property Map>

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

tags List<Property Map>
A list of key-value pairs that contain metadata for the asset.

Outputs

All input properties are implicitly available as output properties. Additionally, the Asset resource produces the following output properties:

AssetArn string
The ARN of the asset
AssetId string
The ID of the asset
Id string
The provider-assigned unique ID for this managed resource.
AssetArn string
The ARN of the asset
AssetId string
The ID of the asset
Id string
The provider-assigned unique ID for this managed resource.
assetArn String
The ARN of the asset
assetId String
The ID of the asset
id String
The provider-assigned unique ID for this managed resource.
assetArn string
The ARN of the asset
assetId string
The ID of the asset
id string
The provider-assigned unique ID for this managed resource.
asset_arn str
The ARN of the asset
asset_id str
The ID of the asset
id str
The provider-assigned unique ID for this managed resource.
assetArn String
The ARN of the asset
assetId String
The ID of the asset
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

AssetHierarchy
, AssetHierarchyArgs

ChildAssetId This property is required. string
The ID of the child asset to be associated.
ExternalId string
String-friendly customer provided external ID
Id string
Customer provided actual UUID for property
LogicalId string
The LogicalID of a hierarchy in the parent asset's model.
ChildAssetId This property is required. string
The ID of the child asset to be associated.
ExternalId string
String-friendly customer provided external ID
Id string
Customer provided actual UUID for property
LogicalId string
The LogicalID of a hierarchy in the parent asset's model.
childAssetId This property is required. String
The ID of the child asset to be associated.
externalId String
String-friendly customer provided external ID
id String
Customer provided actual UUID for property
logicalId String
The LogicalID of a hierarchy in the parent asset's model.
childAssetId This property is required. string
The ID of the child asset to be associated.
externalId string
String-friendly customer provided external ID
id string
Customer provided actual UUID for property
logicalId string
The LogicalID of a hierarchy in the parent asset's model.
child_asset_id This property is required. str
The ID of the child asset to be associated.
external_id str
String-friendly customer provided external ID
id str
Customer provided actual UUID for property
logical_id str
The LogicalID of a hierarchy in the parent asset's model.
childAssetId This property is required. String
The ID of the child asset to be associated.
externalId String
String-friendly customer provided external ID
id String
Customer provided actual UUID for property
logicalId String
The LogicalID of a hierarchy in the parent asset's model.

AssetProperty
, AssetPropertyArgs

Alias string
The property alias that identifies the property.
ExternalId string
String-friendly customer provided external ID
Id string
Customer provided actual UUID for property
LogicalId string
Customer provided ID for property.
NotificationState Pulumi.AwsNative.IoTSiteWise.AssetPropertyNotificationState
The MQTT notification state (ENABLED or DISABLED) for this asset property.
Unit string
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
Alias string
The property alias that identifies the property.
ExternalId string
String-friendly customer provided external ID
Id string
Customer provided actual UUID for property
LogicalId string
Customer provided ID for property.
NotificationState AssetPropertyNotificationState
The MQTT notification state (ENABLED or DISABLED) for this asset property.
Unit string
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
alias String
The property alias that identifies the property.
externalId String
String-friendly customer provided external ID
id String
Customer provided actual UUID for property
logicalId String
Customer provided ID for property.
notificationState AssetPropertyNotificationState
The MQTT notification state (ENABLED or DISABLED) for this asset property.
unit String
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
alias string
The property alias that identifies the property.
externalId string
String-friendly customer provided external ID
id string
Customer provided actual UUID for property
logicalId string
Customer provided ID for property.
notificationState AssetPropertyNotificationState
The MQTT notification state (ENABLED or DISABLED) for this asset property.
unit string
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
alias str
The property alias that identifies the property.
external_id str
String-friendly customer provided external ID
id str
Customer provided actual UUID for property
logical_id str
Customer provided ID for property.
notification_state AssetPropertyNotificationState
The MQTT notification state (ENABLED or DISABLED) for this asset property.
unit str
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
alias String
The property alias that identifies the property.
externalId String
String-friendly customer provided external ID
id String
Customer provided actual UUID for property
logicalId String
Customer provided ID for property.
notificationState "ENABLED" | "DISABLED"
The MQTT notification state (ENABLED or DISABLED) for this asset property.
unit String
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

AssetPropertyNotificationState
, AssetPropertyNotificationStateArgs

Enabled
ENABLED
Disabled
DISABLED
AssetPropertyNotificationStateEnabled
ENABLED
AssetPropertyNotificationStateDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native