Package software.amazon.awscdk.services.iotfleetwise

Class CfnFleet

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.CfnFleet
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.854Z") @Stability(Stable) public class CfnFleet extends CfnResource implements IInspectable
A CloudFormation AWS::IoTFleetWise::Fleet.

Creates a fleet that represents a group of vehicles.

You must create both a signal catalog and vehicles before you can create a fleet.

For more information, see Fleets 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.*;
 CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet")
         .id("id")
         .signalCatalogArn("signalCatalogArn")
         // the properties below are optional
         .description("description")
         .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

    • CfnFleet

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

    • CfnFleet

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

    • CfnFleet

      @Stability(Stable) public CfnFleet(@NotNull Construct scope, @NotNull String id, @NotNull CfnFleetProps props)
      Create a new AWS::IoTFleetWise::Fleet.

      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 created fleet.

    • getAttrCreationTime

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

    • getAttrLastModificationTime

      @Stability(Stable) @NotNull public String getAttrLastModificationTime()
      The time the fleet 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 that can be used to manage the fleet.

    • getId

      @Stability(Stable) @NotNull public String getId()
      The unique ID of the fleet.

    • setId

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

    • getSignalCatalogArn

      @Stability(Stable) @NotNull public String getSignalCatalogArn()
      The ARN of the signal catalog associated with the fleet.

    • setSignalCatalogArn

      @Stability(Stable) public void setSignalCatalogArn(@NotNull String value)
      The ARN of the signal catalog associated with the fleet.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      (Optional) A brief description of the fleet.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      (Optional) A brief description of the fleet.