Class: Aws::IoTFleetWise::Types::CreateStateTemplateRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotfleetwise/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_extra_dimensions ⇒ Array<String>

A list of vehicle attributes to associate with the payload published on the state template’s MQTT topic. (See [ Processing last known state vehicle data using MQTT messaging]). For example, if you add ‘Vehicle.Attributes.Make` and `Vehicle.Attributes.Model` attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the `extraDimensions` field.

[1]: docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data

Returns:

  • (Array<String>) 


988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 988

class CreateStateTemplateRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :state_template_properties,
  :data_extra_dimensions,
  :metadata_extra_dimensions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A brief description of the state template.

Returns:

  • (String) 


988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 988

class CreateStateTemplateRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :state_template_properties,
  :data_extra_dimensions,
  :metadata_extra_dimensions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_extra_dimensions ⇒ Array<String>

A list of vehicle attributes to associate with user properties of the messages published on the state template’s MQTT topic. (See [ Processing last known state vehicle data using MQTT messaging]). For example, if you add ‘Vehicle.Attributes.Make` and `Vehicle.Attributes.Model` attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

Default: An empty array

[1]: docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data

Returns:

  • (Array<String>) 


988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 988

class CreateStateTemplateRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :state_template_properties,
  :data_extra_dimensions,
  :metadata_extra_dimensions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the state template.

Returns:

  • (String) 


988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 988

class CreateStateTemplateRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :state_template_properties,
  :data_extra_dimensions,
  :metadata_extra_dimensions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#signal_catalog_arn ⇒ String

The ARN of the signal catalog associated with the state template.

Returns:

  • (String) 


988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 988

class CreateStateTemplateRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :state_template_properties,
  :data_extra_dimensions,
  :metadata_extra_dimensions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#state_template_properties ⇒ Array<String>

A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

Returns:

  • (Array<String>) 


988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 988

class CreateStateTemplateRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :state_template_properties,
  :data_extra_dimensions,
  :metadata_extra_dimensions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata that can be used to manage the state template.

Returns:



988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 988

class CreateStateTemplateRequest < Struct.new(
  :name,
  :description,
  :signal_catalog_arn,
  :state_template_properties,
  :data_extra_dimensions,
  :metadata_extra_dimensions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end