@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
139 lines (138 loc) • 8.18 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::Location::Tracker Resource Type
*/
export declare class Tracker extends pulumi.CustomResource {
/**
* Get an existing Tracker resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Tracker;
/**
* Returns true if the given object is an instance of Tracker. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Tracker;
/**
* The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS .
*
* - Format example: `arn:aws:geo:region:account-id:tracker/ExampleTracker`
*/
readonly arn: pulumi.Output<string>;
/**
* The timestamp for when the tracker resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
*/
readonly createTime: pulumi.Output<string>;
/**
* An optional description for the tracker resource.
*/
readonly description: pulumi.Output<string | undefined>;
readonly eventBridgeEnabled: pulumi.Output<boolean | undefined>;
readonly kmsKeyEnableGeospatialQueries: pulumi.Output<boolean | undefined>;
/**
* A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) . Enter a key ID, key ARN, alias name, or alias ARN.
*/
readonly kmsKeyId: pulumi.Output<string | undefined>;
/**
* 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` .
*/
readonly positionFiltering: pulumi.Output<enums.location.TrackerPositionFiltering | undefined>;
readonly pricingPlan: pulumi.Output<enums.location.TrackerPricingPlan | undefined>;
/**
* This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
*/
readonly pricingPlanDataSource: pulumi.Output<string | undefined>;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Synonym for `Arn` . The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS .
*
* - Format example: `arn:aws:geo:region:account-id:tracker/ExampleTracker`
*/
readonly trackerArn: pulumi.Output<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` .
*/
readonly trackerName: pulumi.Output<string>;
/**
* The timestamp for when the tracker resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Tracker resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: TrackerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Tracker resource.
*/
export interface TrackerArgs {
/**
* An optional description for the tracker resource.
*/
description?: pulumi.Input<string>;
eventBridgeEnabled?: pulumi.Input<boolean>;
kmsKeyEnableGeospatialQueries?: pulumi.Input<boolean>;
/**
* A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) . Enter a key ID, key ARN, alias name, or alias ARN.
*/
kmsKeyId?: pulumi.Input<string>;
/**
* 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` .
*/
positionFiltering?: pulumi.Input<enums.location.TrackerPositionFiltering>;
pricingPlan?: pulumi.Input<enums.location.TrackerPricingPlan>;
/**
* This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
*/
pricingPlanDataSource?: pulumi.Input<string>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* 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` .
*/
trackerName?: pulumi.Input<string>;
}