Class: AWSCDK::IoTFleetWise::CfnStateTemplateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_fleet_wise/cfn_state_template_props.rb

Overview

Properties for defining a CfnStateTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, signal_catalog_arn:, state_template_properties:, data_extra_dimensions: nil, description: nil, metadata_extra_dimensions: nil, tags: nil) ⇒ CfnStateTemplateProps

Returns a new instance of CfnStateTemplateProps.

Parameters:

  • name (String) —

    The unique alias of the state template.

  • signal_catalog_arn (String) —

    The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

  • state_template_properties (Array<String>) —

    A list of signals from which data is collected.

  • data_extra_dimensions (Array<String>, nil) (defaults to: nil) —

    A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

  • description (String, nil) (defaults to: nil) —

    A brief description of the state template.

  • metadata_extra_dimensions (Array<String>, nil) (defaults to: nil) —

    A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Metadata that can be used to manage the state template.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 16

def initialize(name:, signal_catalog_arn:, state_template_properties:, data_extra_dimensions: nil, description: nil, metadata_extra_dimensions: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @signal_catalog_arn = signal_catalog_arn
  Jsii::Type.check_type(@signal_catalog_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "signalCatalogArn")
  @state_template_properties = state_template_properties
  Jsii::Type.check_type(@state_template_properties, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "stateTemplateProperties")
  @data_extra_dimensions = data_extra_dimensions
  Jsii::Type.check_type(@data_extra_dimensions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dataExtraDimensions") unless @data_extra_dimensions.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @metadata_extra_dimensions = metadata_extra_dimensions
  Jsii::Type.check_type(@metadata_extra_dimensions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "metadataExtraDimensions") unless @metadata_extra_dimensions.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#data_extra_dimensions ⇒ Array<String>? (readonly)

A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

Returns:

  • (Array<String>, nil)

See Also:



54
55
56
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 54

def data_extra_dimensions
  @data_extra_dimensions
end

#description ⇒ String? (readonly)

A brief description of the state template.

Returns:

  • (String, nil)

See Also:



59
60
61
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 59

def description
  @description
end

#metadata_extra_dimensions ⇒ Array<String>? (readonly)

A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.

For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, these attributes are included as user properties with the MQTT message.

Returns:

  • (Array<String>, nil)

See Also:



66
67
68
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 66

def metadata_extra_dimensions
  @metadata_extra_dimensions
end

#name ⇒ String (readonly)

The unique alias of the state template.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 37

def name
  @name
end

#signal_catalog_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 42

def signal_catalog_arn
  @signal_catalog_arn
end

#state_template_properties ⇒ Array<String> (readonly)

A list of signals from which data is collected.

The state template properties contain the fully qualified names of the signals.

Returns:

  • (Array<String>)

See Also:



49
50
51
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 49

def state_template_properties
  @state_template_properties
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Metadata that can be used to manage the state template.

Returns:

See Also:



71
72
73
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 71

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 73

def self.jsii_properties
  {
    :name => "name",
    :signal_catalog_arn => "signalCatalogArn",
    :state_template_properties => "stateTemplateProperties",
    :data_extra_dimensions => "dataExtraDimensions",
    :description => "description",
    :metadata_extra_dimensions => "metadataExtraDimensions",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'io_t_fleet_wise/cfn_state_template_props.rb', line 85

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "signalCatalogArn" => @signal_catalog_arn,
    "stateTemplateProperties" => @state_template_properties,
    "dataExtraDimensions" => @data_extra_dimensions,
    "description" => @description,
    "metadataExtraDimensions" => @metadata_extra_dimensions,
    "tags" => @tags,
  })
  result.compact
end