@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)
145 lines (144 loc) • 8.49 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::PlaceIndex Resource Type
*/
export declare class PlaceIndex extends pulumi.CustomResource {
/**
* Get an existing PlaceIndex 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): PlaceIndex;
/**
* Returns true if the given object is an instance of PlaceIndex. 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 PlaceIndex;
/**
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .
*
* - Format example: `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`
*/
readonly arn: pulumi.Output<string>;
/**
* The timestamp for when the place index 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>;
/**
* Specifies the geospatial data provider for the new place index.
*
* > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error.
*
* Valid values include:
*
* - `Esri` – For additional information about [Esri](https://docs.aws.amazon.com/location/previous/developerguide/esri.html) 's coverage in your region of interest, see [Esri details on geocoding coverage](https://docs.aws.amazon.com/https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm) .
* - `Grab` – Grab provides place index functionality for Southeast Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/previous/developerguide/grab.html) ' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area) .
* - `Here` – For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/previous/developerguide/HERE.html) ' coverage in your region of interest, see [HERE details on goecoding coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html) .
*
* > If you specify HERE Technologies ( `Here` ) as the data provider, you may not [store results](https://docs.aws.amazon.com//location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan. For more information, see the [AWS service terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service.
*
* For additional information , see [Data providers](https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html) on the *Amazon Location Service developer guide* .
*/
readonly dataSource: pulumi.Output<string>;
/**
* Specifies the data storage option requesting Places.
*/
readonly dataSourceConfiguration: pulumi.Output<outputs.location.PlaceIndexDataSourceConfiguration | undefined>;
/**
* The optional description for the place index resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Synonym for `Arn` . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .
*
* - Format example: `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`
*/
readonly indexArn: pulumi.Output<string>;
/**
* The name of the place index resource.
*
* Requirements:
*
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique place index resource name.
* - No spaces allowed. For example, `ExamplePlaceIndex` .
*/
readonly indexName: pulumi.Output<string>;
/**
* No longer used. If included, the only allowed value is `RequestBasedUsage` .
*
* *Allowed Values* : `RequestBasedUsage`
*/
readonly pricingPlan: pulumi.Output<enums.location.PlaceIndexPricingPlan | undefined>;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The timestamp for when the place index 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 PlaceIndex 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: PlaceIndexArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PlaceIndex resource.
*/
export interface PlaceIndexArgs {
/**
* Specifies the geospatial data provider for the new place index.
*
* > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error.
*
* Valid values include:
*
* - `Esri` – For additional information about [Esri](https://docs.aws.amazon.com/location/previous/developerguide/esri.html) 's coverage in your region of interest, see [Esri details on geocoding coverage](https://docs.aws.amazon.com/https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm) .
* - `Grab` – Grab provides place index functionality for Southeast Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/previous/developerguide/grab.html) ' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area) .
* - `Here` – For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/previous/developerguide/HERE.html) ' coverage in your region of interest, see [HERE details on goecoding coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html) .
*
* > If you specify HERE Technologies ( `Here` ) as the data provider, you may not [store results](https://docs.aws.amazon.com//location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan. For more information, see the [AWS service terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service.
*
* For additional information , see [Data providers](https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html) on the *Amazon Location Service developer guide* .
*/
dataSource: pulumi.Input<string>;
/**
* Specifies the data storage option requesting Places.
*/
dataSourceConfiguration?: pulumi.Input<inputs.location.PlaceIndexDataSourceConfigurationArgs>;
/**
* The optional description for the place index resource.
*/
description?: pulumi.Input<string>;
/**
* The name of the place index resource.
*
* Requirements:
*
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique place index resource name.
* - No spaces allowed. For example, `ExamplePlaceIndex` .
*/
indexName?: pulumi.Input<string>;
/**
* No longer used. If included, the only allowed value is `RequestBasedUsage` .
*
* *Allowed Values* : `RequestBasedUsage`
*/
pricingPlan?: pulumi.Input<enums.location.PlaceIndexPricingPlan>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}