aws_sdk_location/operation/create_tracker/_create_tracker_input.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct CreateTrackerInput {
6 /// <p>The name for the tracker resource.</p>
7 /// <p>Requirements:</p>
8 /// <ul>
9 /// <li>
10 /// <p>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</p></li>
11 /// <li>
12 /// <p>Must be a unique tracker resource name.</p></li>
13 /// <li>
14 /// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
15 /// </ul>
16 pub tracker_name: ::std::option::Option<::std::string::String>,
17 /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
18 #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
19 pub pricing_plan: ::std::option::Option<crate::types::PricingPlan>,
20 /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
21 pub kms_key_id: ::std::option::Option<::std::string::String>,
22 /// <p>This parameter is no longer used.</p>
23 #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
24 pub pricing_plan_data_source: ::std::option::Option<::std::string::String>,
25 /// <p>An optional description for the tracker resource.</p>
26 pub description: ::std::option::Option<::std::string::String>,
27 /// <p>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.</p>
28 /// <p>Format: <code>"key" : "value"</code></p>
29 /// <p>Restrictions:</p>
30 /// <ul>
31 /// <li>
32 /// <p>Maximum 50 tags per resource</p></li>
33 /// <li>
34 /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
35 /// <li>
36 /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
37 /// <li>
38 /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
39 /// <li>
40 /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
41 /// <li>
42 /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
43 /// </ul>
44 pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
45 /// <p>Specifies the position filtering for the tracker resource.</p>
46 /// <p>Valid values:</p>
47 /// <ul>
48 /// <li>
49 /// <p><code>TimeBased</code> - 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.</p></li>
50 /// <li>
51 /// <p><code>DistanceBased</code> - 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.</p></li>
52 /// <li>
53 /// <p><code>AccuracyBased</code> - 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.</p></li>
54 /// </ul>
55 /// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
56 pub position_filtering: ::std::option::Option<crate::types::PositionFiltering>,
57 /// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
58 /// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
59 /// </note>
60 pub event_bridge_enabled: ::std::option::Option<bool>,
61 /// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
62 /// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
63 /// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
64 /// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
65 /// </note>
66 pub kms_key_enable_geospatial_queries: ::std::option::Option<bool>,
67}
68impl CreateTrackerInput {
69 /// <p>The name for the tracker resource.</p>
70 /// <p>Requirements:</p>
71 /// <ul>
72 /// <li>
73 /// <p>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</p></li>
74 /// <li>
75 /// <p>Must be a unique tracker resource name.</p></li>
76 /// <li>
77 /// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
78 /// </ul>
79 pub fn tracker_name(&self) -> ::std::option::Option<&str> {
80 self.tracker_name.as_deref()
81 }
82 /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
83 #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
84 pub fn pricing_plan(&self) -> ::std::option::Option<&crate::types::PricingPlan> {
85 self.pricing_plan.as_ref()
86 }
87 /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
88 pub fn kms_key_id(&self) -> ::std::option::Option<&str> {
89 self.kms_key_id.as_deref()
90 }
91 /// <p>This parameter is no longer used.</p>
92 #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
93 pub fn pricing_plan_data_source(&self) -> ::std::option::Option<&str> {
94 self.pricing_plan_data_source.as_deref()
95 }
96 /// <p>An optional description for the tracker resource.</p>
97 pub fn description(&self) -> ::std::option::Option<&str> {
98 self.description.as_deref()
99 }
100 /// <p>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.</p>
101 /// <p>Format: <code>"key" : "value"</code></p>
102 /// <p>Restrictions:</p>
103 /// <ul>
104 /// <li>
105 /// <p>Maximum 50 tags per resource</p></li>
106 /// <li>
107 /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
108 /// <li>
109 /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
110 /// <li>
111 /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
112 /// <li>
113 /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
114 /// <li>
115 /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
116 /// </ul>
117 pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
118 self.tags.as_ref()
119 }
120 /// <p>Specifies the position filtering for the tracker resource.</p>
121 /// <p>Valid values:</p>
122 /// <ul>
123 /// <li>
124 /// <p><code>TimeBased</code> - 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.</p></li>
125 /// <li>
126 /// <p><code>DistanceBased</code> - 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.</p></li>
127 /// <li>
128 /// <p><code>AccuracyBased</code> - 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.</p></li>
129 /// </ul>
130 /// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
131 pub fn position_filtering(&self) -> ::std::option::Option<&crate::types::PositionFiltering> {
132 self.position_filtering.as_ref()
133 }
134 /// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
135 /// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
136 /// </note>
137 pub fn event_bridge_enabled(&self) -> ::std::option::Option<bool> {
138 self.event_bridge_enabled
139 }
140 /// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
141 /// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
142 /// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
143 /// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
144 /// </note>
145 pub fn kms_key_enable_geospatial_queries(&self) -> ::std::option::Option<bool> {
146 self.kms_key_enable_geospatial_queries
147 }
148}
149impl CreateTrackerInput {
150 /// Creates a new builder-style object to manufacture [`CreateTrackerInput`](crate::operation::create_tracker::CreateTrackerInput).
151 pub fn builder() -> crate::operation::create_tracker::builders::CreateTrackerInputBuilder {
152 crate::operation::create_tracker::builders::CreateTrackerInputBuilder::default()
153 }
154}
155
156/// A builder for [`CreateTrackerInput`](crate::operation::create_tracker::CreateTrackerInput).
157#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
158#[non_exhaustive]
159pub struct CreateTrackerInputBuilder {
160 pub(crate) tracker_name: ::std::option::Option<::std::string::String>,
161 pub(crate) pricing_plan: ::std::option::Option<crate::types::PricingPlan>,
162 pub(crate) kms_key_id: ::std::option::Option<::std::string::String>,
163 pub(crate) pricing_plan_data_source: ::std::option::Option<::std::string::String>,
164 pub(crate) description: ::std::option::Option<::std::string::String>,
165 pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
166 pub(crate) position_filtering: ::std::option::Option<crate::types::PositionFiltering>,
167 pub(crate) event_bridge_enabled: ::std::option::Option<bool>,
168 pub(crate) kms_key_enable_geospatial_queries: ::std::option::Option<bool>,
169}
170impl CreateTrackerInputBuilder {
171 /// <p>The name for the tracker resource.</p>
172 /// <p>Requirements:</p>
173 /// <ul>
174 /// <li>
175 /// <p>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</p></li>
176 /// <li>
177 /// <p>Must be a unique tracker resource name.</p></li>
178 /// <li>
179 /// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
180 /// </ul>
181 /// This field is required.
182 pub fn tracker_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
183 self.tracker_name = ::std::option::Option::Some(input.into());
184 self
185 }
186 /// <p>The name for the tracker resource.</p>
187 /// <p>Requirements:</p>
188 /// <ul>
189 /// <li>
190 /// <p>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</p></li>
191 /// <li>
192 /// <p>Must be a unique tracker resource name.</p></li>
193 /// <li>
194 /// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
195 /// </ul>
196 pub fn set_tracker_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
197 self.tracker_name = input;
198 self
199 }
200 /// <p>The name for the tracker resource.</p>
201 /// <p>Requirements:</p>
202 /// <ul>
203 /// <li>
204 /// <p>Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).</p></li>
205 /// <li>
206 /// <p>Must be a unique tracker resource name.</p></li>
207 /// <li>
208 /// <p>No spaces allowed. For example, <code>ExampleTracker</code>.</p></li>
209 /// </ul>
210 pub fn get_tracker_name(&self) -> &::std::option::Option<::std::string::String> {
211 &self.tracker_name
212 }
213 /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
214 #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
215 pub fn pricing_plan(mut self, input: crate::types::PricingPlan) -> Self {
216 self.pricing_plan = ::std::option::Option::Some(input);
217 self
218 }
219 /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
220 #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
221 pub fn set_pricing_plan(mut self, input: ::std::option::Option<crate::types::PricingPlan>) -> Self {
222 self.pricing_plan = input;
223 self
224 }
225 /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
226 #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
227 pub fn get_pricing_plan(&self) -> &::std::option::Option<crate::types::PricingPlan> {
228 &self.pricing_plan
229 }
230 /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
231 pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
232 self.kms_key_id = ::std::option::Option::Some(input.into());
233 self
234 }
235 /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
236 pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
237 self.kms_key_id = input;
238 self
239 }
240 /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
241 pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
242 &self.kms_key_id
243 }
244 /// <p>This parameter is no longer used.</p>
245 #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
246 pub fn pricing_plan_data_source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
247 self.pricing_plan_data_source = ::std::option::Option::Some(input.into());
248 self
249 }
250 /// <p>This parameter is no longer used.</p>
251 #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
252 pub fn set_pricing_plan_data_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
253 self.pricing_plan_data_source = input;
254 self
255 }
256 /// <p>This parameter is no longer used.</p>
257 #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
258 pub fn get_pricing_plan_data_source(&self) -> &::std::option::Option<::std::string::String> {
259 &self.pricing_plan_data_source
260 }
261 /// <p>An optional description for the tracker resource.</p>
262 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
263 self.description = ::std::option::Option::Some(input.into());
264 self
265 }
266 /// <p>An optional description for the tracker resource.</p>
267 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
268 self.description = input;
269 self
270 }
271 /// <p>An optional description for the tracker resource.</p>
272 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
273 &self.description
274 }
275 /// Adds a key-value pair to `tags`.
276 ///
277 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
278 ///
279 /// <p>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.</p>
280 /// <p>Format: <code>"key" : "value"</code></p>
281 /// <p>Restrictions:</p>
282 /// <ul>
283 /// <li>
284 /// <p>Maximum 50 tags per resource</p></li>
285 /// <li>
286 /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
287 /// <li>
288 /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
289 /// <li>
290 /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
291 /// <li>
292 /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
293 /// <li>
294 /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
295 /// </ul>
296 pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
297 let mut hash_map = self.tags.unwrap_or_default();
298 hash_map.insert(k.into(), v.into());
299 self.tags = ::std::option::Option::Some(hash_map);
300 self
301 }
302 /// <p>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.</p>
303 /// <p>Format: <code>"key" : "value"</code></p>
304 /// <p>Restrictions:</p>
305 /// <ul>
306 /// <li>
307 /// <p>Maximum 50 tags per resource</p></li>
308 /// <li>
309 /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
310 /// <li>
311 /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
312 /// <li>
313 /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
314 /// <li>
315 /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
316 /// <li>
317 /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
318 /// </ul>
319 pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
320 self.tags = input;
321 self
322 }
323 /// <p>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.</p>
324 /// <p>Format: <code>"key" : "value"</code></p>
325 /// <p>Restrictions:</p>
326 /// <ul>
327 /// <li>
328 /// <p>Maximum 50 tags per resource</p></li>
329 /// <li>
330 /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
331 /// <li>
332 /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
333 /// <li>
334 /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
335 /// <li>
336 /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
337 /// <li>
338 /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
339 /// </ul>
340 pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
341 &self.tags
342 }
343 /// <p>Specifies the position filtering for the tracker resource.</p>
344 /// <p>Valid values:</p>
345 /// <ul>
346 /// <li>
347 /// <p><code>TimeBased</code> - 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.</p></li>
348 /// <li>
349 /// <p><code>DistanceBased</code> - 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.</p></li>
350 /// <li>
351 /// <p><code>AccuracyBased</code> - 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.</p></li>
352 /// </ul>
353 /// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
354 pub fn position_filtering(mut self, input: crate::types::PositionFiltering) -> Self {
355 self.position_filtering = ::std::option::Option::Some(input);
356 self
357 }
358 /// <p>Specifies the position filtering for the tracker resource.</p>
359 /// <p>Valid values:</p>
360 /// <ul>
361 /// <li>
362 /// <p><code>TimeBased</code> - 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.</p></li>
363 /// <li>
364 /// <p><code>DistanceBased</code> - 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.</p></li>
365 /// <li>
366 /// <p><code>AccuracyBased</code> - 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.</p></li>
367 /// </ul>
368 /// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
369 pub fn set_position_filtering(mut self, input: ::std::option::Option<crate::types::PositionFiltering>) -> Self {
370 self.position_filtering = input;
371 self
372 }
373 /// <p>Specifies the position filtering for the tracker resource.</p>
374 /// <p>Valid values:</p>
375 /// <ul>
376 /// <li>
377 /// <p><code>TimeBased</code> - 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.</p></li>
378 /// <li>
379 /// <p><code>DistanceBased</code> - 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.</p></li>
380 /// <li>
381 /// <p><code>AccuracyBased</code> - 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.</p></li>
382 /// </ul>
383 /// <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
384 pub fn get_position_filtering(&self) -> &::std::option::Option<crate::types::PositionFiltering> {
385 &self.position_filtering
386 }
387 /// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
388 /// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
389 /// </note>
390 pub fn event_bridge_enabled(mut self, input: bool) -> Self {
391 self.event_bridge_enabled = ::std::option::Option::Some(input);
392 self
393 }
394 /// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
395 /// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
396 /// </note>
397 pub fn set_event_bridge_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
398 self.event_bridge_enabled = input;
399 self
400 }
401 /// <p>Whether to enable position <code>UPDATE</code> events from this tracker to be sent to EventBridge.</p><note>
402 /// <p>You do not need enable this feature to get <code>ENTER</code> and <code>EXIT</code> events for geofences with this tracker. Those events are always sent to EventBridge.</p>
403 /// </note>
404 pub fn get_event_bridge_enabled(&self) -> &::std::option::Option<bool> {
405 &self.event_bridge_enabled
406 }
407 /// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
408 /// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
409 /// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
410 /// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
411 /// </note>
412 pub fn kms_key_enable_geospatial_queries(mut self, input: bool) -> Self {
413 self.kms_key_enable_geospatial_queries = ::std::option::Option::Some(input);
414 self
415 }
416 /// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
417 /// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
418 /// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
419 /// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
420 /// </note>
421 pub fn set_kms_key_enable_geospatial_queries(mut self, input: ::std::option::Option<bool>) -> Self {
422 self.kms_key_enable_geospatial_queries = input;
423 self
424 }
425 /// <p>Enables <code>GeospatialQueries</code> for a tracker that uses a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>.</p>
426 /// <p>This parameter is only used if you are using a KMS customer managed key.</p><note>
427 /// <p>If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.</p>
428 /// <p>You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the <code>KmsKeyEnableGeospatialQueries</code> parameter to true when creating or updating a Tracker.</p>
429 /// </note>
430 pub fn get_kms_key_enable_geospatial_queries(&self) -> &::std::option::Option<bool> {
431 &self.kms_key_enable_geospatial_queries
432 }
433 /// Consumes the builder and constructs a [`CreateTrackerInput`](crate::operation::create_tracker::CreateTrackerInput).
434 pub fn build(
435 self,
436 ) -> ::std::result::Result<crate::operation::create_tracker::CreateTrackerInput, ::aws_smithy_types::error::operation::BuildError> {
437 ::std::result::Result::Ok(crate::operation::create_tracker::CreateTrackerInput {
438 tracker_name: self.tracker_name,
439 pricing_plan: self.pricing_plan,
440 kms_key_id: self.kms_key_id,
441 pricing_plan_data_source: self.pricing_plan_data_source,
442 description: self.description,
443 tags: self.tags,
444 position_filtering: self.position_filtering,
445 event_bridge_enabled: self.event_bridge_enabled,
446 kms_key_enable_geospatial_queries: self.kms_key_enable_geospatial_queries,
447 })
448 }
449}