@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
182 lines (181 loc) • 7.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a Location Service Place Index.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.location.PlaceIndex("example", {
* dataSource: "Here",
* indexName: "example",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_location_place_index` resources using the place index name. For example:
*
* ```sh
* $ pulumi import aws:location/placeIndex:PlaceIndex example example
* ```
*/
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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PlaceIndexState, 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 timestamp for when the place index resource was created in ISO 8601 format.
*/
readonly createTime: pulumi.Output<string>;
/**
* Specifies the geospatial data provider for the new place index.
*/
readonly dataSource: pulumi.Output<string>;
/**
* Configuration block with the data storage option chosen for requesting Places. Detailed below.
*/
readonly dataSourceConfiguration: pulumi.Output<outputs.location.PlaceIndexDataSourceConfiguration>;
/**
* The optional description for the place index resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
*/
readonly indexArn: pulumi.Output<string>;
/**
* The name of the place index resource.
*
* The following arguments are optional:
*/
readonly indexName: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Key-value tags for the place index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The timestamp for when the place index resource was last update in ISO 8601.
*/
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);
}
/**
* Input properties used for looking up and filtering PlaceIndex resources.
*/
export interface PlaceIndexState {
/**
* The timestamp for when the place index resource was created in ISO 8601 format.
*/
createTime?: pulumi.Input<string>;
/**
* Specifies the geospatial data provider for the new place index.
*/
dataSource?: pulumi.Input<string>;
/**
* Configuration block with the data storage option chosen for requesting Places. Detailed below.
*/
dataSourceConfiguration?: pulumi.Input<inputs.location.PlaceIndexDataSourceConfiguration>;
/**
* The optional description for the place index resource.
*/
description?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
*/
indexArn?: pulumi.Input<string>;
/**
* The name of the place index resource.
*
* The following arguments are optional:
*/
indexName?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value tags for the place index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The timestamp for when the place index resource was last update in ISO 8601.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a PlaceIndex resource.
*/
export interface PlaceIndexArgs {
/**
* Specifies the geospatial data provider for the new place index.
*/
dataSource: pulumi.Input<string>;
/**
* Configuration block with the data storage option chosen for requesting Places. Detailed below.
*/
dataSourceConfiguration?: pulumi.Input<inputs.location.PlaceIndexDataSourceConfiguration>;
/**
* The optional description for the place index resource.
*/
description?: pulumi.Input<string>;
/**
* The name of the place index resource.
*
* The following arguments are optional:
*/
indexName: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value tags for the place index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}