Struct CreateTrackerFluentBuilder 

pub struct CreateTrackerFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateTracker.

Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.

Implementations

impl CreateTrackerFluentBuilder

pub fn as_input(&self) -> &CreateTrackerInputBuilder

Access the CreateTracker as a reference.

pub async fn send( self, ) -> Result<CreateTrackerOutput, SdkError<CreateTrackerError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateTrackerOutput, CreateTrackerError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn tracker_name(self, input: impl Into<String>) -> Self

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.

pub fn set_tracker_name(self, input: Option<String>) -> Self

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.

pub fn get_tracker_name(&self) -> &Option<String>

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.

pub fn pricing_plan(self, input: PricingPlan) -> Self

👎Deprecated since 2022-02-01: Deprecated. If included, the only allowed value is RequestBasedUsage.

No longer used. If included, the only allowed value is RequestBasedUsage.

pub fn set_pricing_plan(self, input: Option<PricingPlan>) -> Self

👎Deprecated since 2022-02-01: Deprecated. If included, the only allowed value is RequestBasedUsage.

No longer used. If included, the only allowed value is RequestBasedUsage.

pub fn get_pricing_plan(&self) -> &Option<PricingPlan>

👎Deprecated since 2022-02-01: Deprecated. If included, the only allowed value is RequestBasedUsage.

No longer used. If included, the only allowed value is RequestBasedUsage.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

pub fn set_kms_key_id(self, input: Option<String>) -> Self

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

pub fn get_kms_key_id(&self) -> &Option<String>

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

pub fn pricing_plan_data_source(self, input: impl Into<String>) -> Self

👎Deprecated since 2022-02-01: Deprecated. No longer allowed.

This parameter is no longer used.

pub fn set_pricing_plan_data_source(self, input: Option<String>) -> Self

👎Deprecated since 2022-02-01: Deprecated. No longer allowed.

This parameter is no longer used.

pub fn get_pricing_plan_data_source(&self) -> &Option<String>

👎Deprecated since 2022-02-01: Deprecated. No longer allowed.

This parameter is no longer used.

pub fn description(self, input: impl Into<String>) -> Self

An optional description for the tracker resource.

pub fn set_description(self, input: Option<String>) -> Self

An optional description for the tracker resource.

pub fn get_description(&self) -> &Option<String>

An optional description for the tracker resource.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_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.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

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.

pub fn position_filtering(self, input: PositionFiltering) -> Self

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.

pub fn set_position_filtering(self, input: Option<PositionFiltering>) -> Self

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.

pub fn get_position_filtering(&self) -> &Option<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.

pub fn event_bridge_enabled(self, input: bool) -> Self

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.

pub fn set_event_bridge_enabled(self, input: Option<bool>) -> Self

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.

pub fn get_event_bridge_enabled(&self) -> &Option<bool>

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.

pub fn kms_key_enable_geospatial_queries(self, input: bool) -> Self

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

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.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

pub fn set_kms_key_enable_geospatial_queries(self, input: Option<bool>) -> Self

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

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.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

pub fn get_kms_key_enable_geospatial_queries(&self) -> &Option<bool>

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

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.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

Trait Implementations

impl Clone for CreateTrackerFluentBuilder

fn clone(&self) -> CreateTrackerFluentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateTrackerFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.