PlaceIndex class

Provides a Location Service Place Index.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.location.PlaceIndex("example", {
    dataSource: "Here",
    indexName: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.location.PlaceIndex("example",
    data_source="Here",
    index_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Location.PlaceIndex("example", new()
    {
        DataSource = "Here",
        IndexName = "example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/location"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := location.NewPlaceIndex(ctx, "example", &location.PlaceIndexArgs{
			DataSource: pulumi.String("Here"),
			IndexName:  pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_location_placeindex" "example" {
  data_source = "Here"
  index_name  = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.location.PlaceIndex;
import com.pulumi.aws.location.PlaceIndexArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PlaceIndex("example", PlaceIndexArgs.builder()
            .dataSource("Here")
            .indexName("example")
            .build());

    }
}
resources:
  example:
    type: aws:location:PlaceIndex
    properties:
      dataSource: Here
      indexName: example

Import

Using pulumi import, import aws.location.PlaceIndex resources using the place index name. For example:

$ pulumi import aws:location/placeIndex:PlaceIndex example example

Constructors

PlaceIndex(String name, {PlaceIndexArgs? args, CustomResourceOptions? options})
Creates a new PlaceIndex. name The Pulumi resource name. args Arguments used to configure this PlaceIndex. The set of arguments for PlaceIndex. options Resource options controlling this resource's behavior.
PlaceIndex.reference(String urn)
Creates a typed reference to an existing PlaceIndex resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createTime ↔ Output<String>
Timestamp for when the place index resource was created in ISO 8601 format.
latefinal
dataSource ↔ Output<String>
Geospatial data provider for the new place index.
latefinal
dataSourceConfiguration ↔ Output<PlaceIndexDataSourceConfiguration>
Configuration block with the data storage option chosen for requesting Places. Detailed below.
latefinal
description ↔ Output<String?>
Optional description for the place index resource.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
indexArn ↔ Output<String>
ARN for the place index resource. Used to specify a resource across AWS.
latefinal
indexName ↔ Output<String>
Name of the place index resource.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, 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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>
Timestamp for when the place index resource was last updated in ISO 8601 format.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PlaceIndexState? state, CustomResourceOptions? options}) → PlaceIndex
Gets an existing PlaceIndex resource's state with the given name and id.