Class: AWSCDK::IoTFleetWise::CfnVehicleProps

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

Overview

Properties for defining a CfnVehicle.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(decoder_manifest_arn:, model_manifest_arn:, name:, association_behavior: nil, attributes: nil, state_templates: nil, tags: nil) ⇒ CfnVehicleProps

Returns a new instance of CfnVehicleProps.

Parameters:

  • decoder_manifest_arn (String) —

    The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.

  • model_manifest_arn (String) —

    The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.

  • name (String) —

    The unique ID of the vehicle.

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

    An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.

  • attributes (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

    Static information about a vehicle in a key-value pair.

  • state_templates (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::IoTFleetWise::CfnVehicle::StateTemplateAssociationProperty>, nil) (defaults to: nil) —

    Associate state templates to track the state of the vehicle.

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

    Metadata which can be used to manage the vehicle.



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

def initialize(decoder_manifest_arn:, model_manifest_arn:, name:, association_behavior: nil, attributes: nil, state_templates: nil, tags: nil)
  @decoder_manifest_arn = decoder_manifest_arn
  Jsii::Type.check_type(@decoder_manifest_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "decoderManifestArn")
  @model_manifest_arn = model_manifest_arn
  Jsii::Type.check_type(@model_manifest_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelManifestArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @association_behavior = association_behavior
  Jsii::Type.check_type(@association_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "associationBehavior") unless @association_behavior.nil?
  @attributes = attributes
  Jsii::Type.check_type(@attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "attributes") unless @attributes.nil?
  @state_templates = state_templates
  Jsii::Type.check_type(@state_templates, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90ZmxlZXR3aXNlLkNmblZlaGljbGUuU3RhdGVUZW1wbGF0ZUFzc29jaWF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "stateTemplates") unless @state_templates.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

#association_behavior ⇒ String? (readonly)

An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'io_t_fleet_wise/cfn_vehicle_props.rb', line 52

def association_behavior
  @association_behavior
end

#attributes ⇒ AWSCDK::IResolvable, ... (readonly)

Static information about a vehicle in a key-value pair.

For example: "engine Type" : "v6"

Returns:

See Also:



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

def attributes
  @attributes
end

#decoder_manifest_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.

Returns:

  • (String)

See Also:



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

def decoder_manifest_arn
  @decoder_manifest_arn
end

#model_manifest_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.

Returns:

  • (String)

See Also:



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

def model_manifest_arn
  @model_manifest_arn
end

#name ⇒ String (readonly)

The unique ID of the vehicle.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'io_t_fleet_wise/cfn_vehicle_props.rb', line 47

def name
  @name
end

#state_templates ⇒ AWSCDK::IResolvable, ... (readonly)

Associate state templates to track the state of the vehicle.

State templates determine which signal updates the vehicle sends to the cloud.

Returns:

See Also:



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

def state_templates
  @state_templates
end

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

Metadata which can be used to manage the vehicle.

Returns:

See Also:



71
72
73
 
# File 'io_t_fleet_wise/cfn_vehicle_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_vehicle_props.rb', line 73

def self.jsii_properties
  {
    :decoder_manifest_arn => "decoderManifestArn",
    :model_manifest_arn => "modelManifestArn",
    :name => "name",
    :association_behavior => "associationBehavior",
    :attributes => "attributes",
    :state_templates => "stateTemplates",
    :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_vehicle_props.rb', line 85

def to_jsii
  result = {}
  result.merge!({
    "decoderManifestArn" => @decoder_manifest_arn,
    "modelManifestArn" => @model_manifest_arn,
    "name" => @name,
    "associationBehavior" => @association_behavior,
    "attributes" => @attributes,
    "stateTemplates" => @state_templates,
    "tags" => @tags,
  })
  result.compact
end