Package software.amazon.awscdk.services.location

Class CfnTracker.Builder

java.lang.Object
software.amazon.awscdk.services.location.CfnTracker.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTracker>
Enclosing class:
CfnTracker
@Stability(Stable) public static final class CfnTracker.Builder extends Object implements software.amazon.jsii.Builder<CfnTracker>
A fluent builder for CfnTracker.

  • Method Details

    • create

      @Stability(Stable) public static CfnTracker.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnTracker.Builder.

    • trackerName

      @Stability(Stable) public CfnTracker.Builder trackerName(String trackerName)
      The name for the tracker resource.

      Requirements:

      • Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
      • Must be a unique tracker resource name.
      • No spaces allowed. For example, ExampleTracker .

      Parameters:
      trackerName - The name for the tracker resource. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnTracker.Builder description(String description)
      An optional description for the tracker resource.

      Parameters:
      description - An optional description for the tracker resource. This parameter is required.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnTracker.Builder kmsKeyId(String kmsKeyId)
      A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

      Parameters:
      kmsKeyId - A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN. This parameter is required.
      Returns:
      this

    • positionFiltering

      @Stability(Stable) public CfnTracker.Builder positionFiltering(String positionFiltering)
      Specifies the position filtering for the tracker resource.

      Valid values:

      • TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
      • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
      • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

      This field is optional. If not specified, the default value is TimeBased .

      Parameters:
      positionFiltering - Specifies the position filtering for the tracker resource. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTracker build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTracker>
      Returns:
      a newly built instance of CfnTracker.