/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the location-2020-11-19.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.LocationService.Model
{
///
/// Container for the parameters to the CreateTracker operation.
/// Creates a tracker resource in your Amazon Web Services account, which lets you retrieve
/// current and historical location of devices.
///
public partial class CreateTrackerRequest : AmazonLocationServiceRequest
{
private string _description;
private bool? _eventBridgeEnabled;
private string _kmsKeyId;
private PositionFiltering _positionFiltering;
private PricingPlan _pricingPlan;
private string _pricingPlanDataSource;
private Dictionary _tags = new Dictionary();
private string _trackerName;
///
/// Gets and sets the property Description.
///
/// An optional description for the tracker resource.
///
///
[AWSProperty(Min=0, Max=1000)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property EventBridgeEnabled.
///
/// Whether to enable position UPDATE
events from this tracker to be sent
/// to EventBridge.
///
///
///
/// You do not need enable this feature to get ENTER
and EXIT
/// events for geofences with this tracker. Those events are always sent to EventBridge.
///
///
///
public bool EventBridgeEnabled
{
get { return this._eventBridgeEnabled.GetValueOrDefault(); }
set { this._eventBridgeEnabled = value; }
}
// Check to see if EventBridgeEnabled property is set
internal bool IsSetEventBridgeEnabled()
{
return this._eventBridgeEnabled.HasValue;
}
///
/// Gets and sets the property KmsKeyId.
///
/// A key identifier for an Amazon
/// Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or
/// alias ARN.
///
///
[AWSProperty(Min=1, Max=2048)]
public string KmsKeyId
{
get { return this._kmsKeyId; }
set { this._kmsKeyId = value; }
}
// Check to see if KmsKeyId property is set
internal bool IsSetKmsKeyId()
{
return this._kmsKeyId != null;
}
///
/// Gets and sets the property 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
.
///
///
public PositionFiltering PositionFiltering
{
get { return this._positionFiltering; }
set { this._positionFiltering = value; }
}
// Check to see if PositionFiltering property is set
internal bool IsSetPositionFiltering()
{
return this._positionFiltering != null;
}
///
/// Gets and sets the property PricingPlan.
///
/// No longer used. If included, the only allowed value is RequestBasedUsage
.
///
///
[Obsolete("Deprecated. If included, the only allowed value is RequestBasedUsage.")]
public PricingPlan PricingPlan
{
get { return this._pricingPlan; }
set { this._pricingPlan = value; }
}
// Check to see if PricingPlan property is set
internal bool IsSetPricingPlan()
{
return this._pricingPlan != null;
}
///
/// Gets and sets the property PricingPlanDataSource.
///
/// This parameter is no longer used.
///
///
[Obsolete("Deprecated. No longer allowed.")]
public string PricingPlanDataSource
{
get { return this._pricingPlanDataSource; }
set { this._pricingPlanDataSource = value; }
}
// Check to see if PricingPlanDataSource property is set
internal bool IsSetPricingPlanDataSource()
{
return this._pricingPlanDataSource != null;
}
///
/// Gets and sets the property Tags.
///
/// Applies one or more tags to the tracker resource. A tag is a key-value pair helps
/// manage, identify, search, and filter your resources by labelling them.
///
///
///
/// Format: "key" : "value"
///
///
///
/// Restrictions:
///
/// -
///
/// Maximum 50 tags per resource
///
///
-
///
/// Each resource tag must be unique with a maximum of one value.
///
///
-
///
/// Maximum key length: 128 Unicode characters in UTF-8
///
///
-
///
/// Maximum value length: 256 Unicode characters in UTF-8
///
///
-
///
/// Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
/// = . _ : / @.
///
///
-
///
/// Cannot use "aws:" as a prefix for a key.
///
///
///
[AWSProperty(Min=0, Max=50)]
public Dictionary Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
///
/// Gets and sets the property 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
.
///
///
///
[AWSProperty(Required=true, Min=1, Max=100)]
public string TrackerName
{
get { return this._trackerName; }
set { this._trackerName = value; }
}
// Check to see if TrackerName property is set
internal bool IsSetTrackerName()
{
return this._trackerName != null;
}
}
}