Package software.amazon.awscdk.services.iotfleetwise

Class CfnVehicle

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotfleetwise.CfnVehicle
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.881Z") @Stability(Stable) public class CfnVehicle extends CfnResource implements IInspectable
A CloudFormation AWS::IoTFleetWise::Vehicle.

Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.

If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing.

For more information, see Create a vehicle (console) in the AWS IoT FleetWise Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotfleetwise.*;
 CfnVehicle cfnVehicle = CfnVehicle.Builder.create(this, "MyCfnVehicle")
         .decoderManifestArn("decoderManifestArn")
         .modelManifestArn("modelManifestArn")
         .name("name")
         // the properties below are optional
         .associationBehavior("associationBehavior")
         .attributes(Map.of(
                 "attributesKey", "attributes"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVehicle

      protected CfnVehicle(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVehicle

      protected CfnVehicle(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVehicle

      @Stability(Stable) public CfnVehicle(@NotNull Construct scope, @NotNull String id, @NotNull CfnVehicleProps props)
      Create a new AWS::IoTFleetWise::Vehicle.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the vehicle.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).

    • getAttrLastModificationTime

      @Stability(Stable) @NotNull public String getAttrLastModificationTime()
      The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      (Optional) Metadata which can be used to manage the vehicle.

    • getDecoderManifestArn

      @Stability(Stable) @NotNull public String getDecoderManifestArn()
      The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.

    • setDecoderManifestArn

      @Stability(Stable) public void setDecoderManifestArn(@NotNull String value)
      The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.

    • getModelManifestArn

      @Stability(Stable) @NotNull public String getModelManifestArn()
      The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.

    • setModelManifestArn

      @Stability(Stable) public void setModelManifestArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The unique ID of the vehicle.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The unique ID of the vehicle.

    • getAssociationBehavior

      @Stability(Stable) @Nullable public String getAssociationBehavior()
      (Optional) An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.

    • setAssociationBehavior

      @Stability(Stable) public void setAssociationBehavior(@Nullable String value)
      (Optional) An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.

    • getAttributes

      @Stability(Stable) @Nullable public Object getAttributes()
      (Optional) Static information about a vehicle in a key-value pair.

      For example: "engine Type" : "v6"

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable IResolvable value)
      (Optional) Static information about a vehicle in a key-value pair.

      For example: "engine Type" : "v6"

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable Map<String,String> value)
      (Optional) Static information about a vehicle in a key-value pair.

      For example: "engine Type" : "v6"