Interface PlaceIndexProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
PlaceIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:27.818Z") @Stability(Experimental) public interface PlaceIndexProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for a place index.

Example:

 PlaceIndex.Builder.create(this, "PlaceIndex")
         .placeIndexName("MyPlaceIndex") // optional, defaults to a generated name
         .dataSource(DataSource.HERE)
         .build();
 
  • Method Details

    • getDataSource

      @Stability(Experimental) @Nullable default DataSource getDataSource()
      (experimental) Data source for the place index.

      Default: DataSource.ESRI

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) A description for the place index.

      Default: - no description

    • getIntendedUse

      @Stability(Experimental) @Nullable default IntendedUse getIntendedUse()
      (experimental) Intend use for the results of an operation.

      Default: IntendedUse.SINGLE_USE

    • getPlaceIndexName

      @Stability(Experimental) @Nullable default String getPlaceIndexName()
      (experimental) A name for the place index.

      Default: - A name is automatically generated

    • builder

      @Stability(Experimental) static PlaceIndexProps.Builder builder()
      Returns:
      a PlaceIndexProps.Builder of PlaceIndexProps