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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnVehicle
(Construct scope, String id, CfnVehicleProps props) Create a newAWS::IoTFleetWise::Vehicle
.protected
CfnVehicle
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnVehicle
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescription(Optional) An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.The Amazon Resource Name (ARN) of the vehicle.The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).(Optional) Static information about a vehicle in a key-value pair.The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.getName()
The unique ID of the vehicle.getTags()
(Optional) Metadata which can be used to manage the vehicle.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAssociationBehavior
(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.void
setAttributes
(Map<String, String> value) (Optional) Static information about a vehicle in a key-value pair.void
setAttributes
(IResolvable value) (Optional) Static information about a vehicle in a key-value pair.void
setDecoderManifestArn
(String value) The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.void
setModelManifestArn
(String value) The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.void
The unique ID of the vehicle.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::IoTFleetWise::Vehicle
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the vehicle. -
getAttrCreationTime
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time). -
getAttrLastModificationTime
The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
(Optional) Metadata which can be used to manage the vehicle. -
getDecoderManifestArn
The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create. -
setDecoderManifestArn
The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create. -
getModelManifestArn
The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from. -
setModelManifestArn
The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from. -
getName
The unique ID of the vehicle. -
setName
The unique ID of the vehicle. -
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
(Optional) An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle. -
getAttributes
(Optional) Static information about a vehicle in a key-value pair.For example:
"engine Type"
:"v6"
-
setAttributes
(Optional) Static information about a vehicle in a key-value pair.For example:
"engine Type"
:"v6"
-
setAttributes
(Optional) Static information about a vehicle in a key-value pair.For example:
"engine Type"
:"v6"
-