Package com.pulumi.aws.location

Class PlaceIndex

  • public class PlaceIndex
extends com.pulumi.resources.CustomResource
    Provides a Location Service Place Index. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.location.PlaceIndex` resources using the place index name. For example: ```sh $ pulumi import aws:location/placeIndex:PlaceIndex example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> createTime()  
      com.pulumi.core.Output<java.lang.String> dataSource()  
      com.pulumi.core.Output<PlaceIndexDataSourceConfiguration> dataSourceConfiguration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static PlaceIndex get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PlaceIndexState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> indexArn()  
      com.pulumi.core.Output<java.lang.String> indexName()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> updateTime()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PlaceIndex

        public PlaceIndex​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • PlaceIndex

        public PlaceIndex​(java.lang.String name,
                  PlaceIndexArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • PlaceIndex

        public PlaceIndex​(java.lang.String name,
                  PlaceIndexArgs args,
                  @Nullable
                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • createTime

        public com.pulumi.core.Output<java.lang.String> createTime()
        Returns:
        Timestamp for when the place index resource was created in ISO 8601 format.

      • dataSource

        public com.pulumi.core.Output<java.lang.String> dataSource()
        Returns:
        Geospatial data provider for the new place index.

      • dataSourceConfiguration

        public com.pulumi.core.Output<PlaceIndexDataSourceConfiguration> dataSourceConfiguration()
        Returns:
        Configuration block with the data storage option chosen for requesting Places. Detailed below.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Optional description for the place index resource.

      • indexArn

        public com.pulumi.core.Output<java.lang.String> indexArn()
        Returns:
        ARN for the place index resource. Used to specify a resource across AWS.

      • indexName

        public com.pulumi.core.Output<java.lang.String> indexName()
        Returns:
        Name of the place index resource. The following arguments are optional:

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • updateTime

        public com.pulumi.core.Output<java.lang.String> updateTime()
        Returns:
        Timestamp for when the place index resource was last updated in ISO 8601 format.

      • get

        public static PlaceIndex get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             PlaceIndexState state,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.