This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Location::PlaceIndex
<a name="aws-resource-location-placeindex"></a>

Specifies a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the `SearchPlaceIndexForText` operation, and reverse geocode coordinates by using the `SearchPlaceIndexForPosition` operation, and enable autosuggestions by using the `SearchPlaceIndexForSuggestions` operation.

**Note**  
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the [AWS service terms](https://aws.amazon.com/service-terms) for more details.

## Syntax
<a name="aws-resource-location-placeindex-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-location-placeindex-syntax.json"></a>

```
{
  "Type" : "AWS::Location::PlaceIndex",
  "Properties" : {
      "[DataSource](#cfn-location-placeindex-datasource)" : String,
      "[DataSourceConfiguration](#cfn-location-placeindex-datasourceconfiguration)" : DataSourceConfiguration,
      "[Description](#cfn-location-placeindex-description)" : String,
      "[IndexName](#cfn-location-placeindex-indexname)" : String,
      "[PricingPlan](#cfn-location-placeindex-pricingplan)" : String,
      "[Tags](#cfn-location-placeindex-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-location-placeindex-syntax.yaml"></a>

```
Type: AWS::Location::PlaceIndex
Properties:
  [DataSource](#cfn-location-placeindex-datasource): String
  [DataSourceConfiguration](#cfn-location-placeindex-datasourceconfiguration): 
    DataSourceConfiguration
  [Description](#cfn-location-placeindex-description): String
  [IndexName](#cfn-location-placeindex-indexname): String
  [PricingPlan](#cfn-location-placeindex-pricingplan): String
  [Tags](#cfn-location-placeindex-tags): 
    - Tag
```

## Properties
<a name="aws-resource-location-placeindex-properties"></a>

`DataSource`  <a name="cfn-location-placeindex-datasource"></a>
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://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://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html).
**Important**  
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://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*.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DataSourceConfiguration`  <a name="cfn-location-placeindex-datasourceconfiguration"></a>
Specifies the data storage option requesting Places.  
*Required*: No  
*Type*: [DataSourceConfiguration](aws-properties-location-placeindex-datasourceconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-location-placeindex-description"></a>
The optional description for the place index resource.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexName`  <a name="cfn-location-placeindex-indexname"></a>
The name of the place index resource.   
Requirements:  
+ Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (\$1).
+ Must be a unique place index resource name.
+ No spaces allowed. For example, `ExamplePlaceIndex`.
*Required*: Yes  
*Type*: String  
*Pattern*: `^[-._\w]+$`  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PricingPlan`  <a name="cfn-location-placeindex-pricingplan"></a>
No longer used. If included, the only allowed value is `RequestBasedUsage`.  
*Allowed Values*: `RequestBasedUsage`  
*Required*: No  
*Type*: String  
*Allowed values*: `RequestBasedUsage`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-location-placeindex-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-location-placeindex-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-location-placeindex-return-values"></a>

### Ref
<a name="aws-resource-location-placeindex-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `PlaceIndex` name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-location-placeindex-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-location-placeindex-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
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`

`CreateTime`  <a name="CreateTime-fn::getatt"></a>
The timestamp for when the place index resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ`.

`IndexArn`  <a name="IndexArn-fn::getatt"></a>
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`

`UpdateTime`  <a name="UpdateTime-fn::getatt"></a>
The timestamp for when the place index resource was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ`.

# AWS::Location::PlaceIndex DataSourceConfiguration
<a name="aws-properties-location-placeindex-datasourceconfiguration"></a>

Specifies the data storage option requesting Places.

## Syntax
<a name="aws-properties-location-placeindex-datasourceconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-location-placeindex-datasourceconfiguration-syntax.json"></a>

```
{
  "[IntendedUse](#cfn-location-placeindex-datasourceconfiguration-intendeduse)" : String
}
```

### YAML
<a name="aws-properties-location-placeindex-datasourceconfiguration-syntax.yaml"></a>

```
  [IntendedUse](#cfn-location-placeindex-datasourceconfiguration-intendeduse): String
```

## Properties
<a name="aws-properties-location-placeindex-datasourceconfiguration-properties"></a>

`IntendedUse`  <a name="cfn-location-placeindex-datasourceconfiguration-intendeduse"></a>
Specifies how the results of an operation will be stored by the caller.   
Valid values include:  
+ `SingleUse` specifies that the results won't be stored. 
+ `Storage` specifies that the result can be cached or stored in a database.
Default value: `SingleUse`  
*Required*: No  
*Type*: String  
*Allowed values*: `SingleUse | Storage`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Location::PlaceIndex Tag
<a name="aws-properties-location-placeindex-tag"></a>

<a name="aws-properties-location-placeindex-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::Location::PlaceIndex](aws-resource-location-placeindex.md).

## Syntax
<a name="aws-properties-location-placeindex-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-location-placeindex-tag-syntax.json"></a>

```
{
  "[Key](#cfn-location-placeindex-tag-key)" : String,
  "[Value](#cfn-location-placeindex-tag-value)" : String
}
```

### YAML
<a name="aws-properties-location-placeindex-tag-syntax.yaml"></a>

```
  [Key](#cfn-location-placeindex-tag-key): String
  [Value](#cfn-location-placeindex-tag-value): String
```

## Properties
<a name="aws-properties-location-placeindex-tag-properties"></a>

`Key`  <a name="cfn-location-placeindex-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-location-placeindex-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z0-9 _=@:.+-/]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)