Class: Aws::IoTSiteWise::Types::AssetModelCompositeModelDefinition

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::AssetModelCompositeModelDefinition

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the composite model.

• #external_id ⇒ String

  An external ID to assign to the composite model.

• #id ⇒ String

  The ID to assign to the composite model, if desired.

• #name ⇒ String

  The name of the composite model.

• #properties ⇒ Array<Types::AssetModelPropertyDefinition>

  The asset property definitions for this composite model.

• #type ⇒ String

  The type of the composite model.

Instance Attribute Details

#description ⇒ String

The description of the composite model.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 534

class AssetModelCompositeModelDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 534

class AssetModelCompositeModelDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 534

class AssetModelCompositeModelDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the composite model.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 534

class AssetModelCompositeModelDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#properties ⇒ Array<Types::AssetModelPropertyDefinition>

The asset property definitions for this composite model.

Returns:

• (Array<Types::AssetModelPropertyDefinition>)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 534

class AssetModelCompositeModelDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 534

class AssetModelCompositeModelDefinition < Struct.new(
  :id,
  :external_id,
  :name,
  :description,
  :type,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end