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::Map
<a name="aws-resource-location-map"></a>

The `AWS::Location::Map` resource specifies a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

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

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

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

```
{
  "Type" : "AWS::Location::Map",
  "Properties" : {
      "[Configuration](#cfn-location-map-configuration)" : MapConfiguration,
      "[Description](#cfn-location-map-description)" : String,
      "[MapName](#cfn-location-map-mapname)" : String,
      "[PricingPlan](#cfn-location-map-pricingplan)" : String,
      "[Tags](#cfn-location-map-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::Location::Map
Properties:
  [Configuration](#cfn-location-map-configuration): 
    MapConfiguration
  [Description](#cfn-location-map-description): String
  [MapName](#cfn-location-map-mapname): String
  [PricingPlan](#cfn-location-map-pricingplan): String
  [Tags](#cfn-location-map-tags): 
    - Tag
```

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

`Configuration`  <a name="cfn-location-map-configuration"></a>
Specifies the `MapConfiguration`, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.  
*Required*: Yes  
*Type*: [MapConfiguration](aws-properties-location-map-mapconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-location-map-description"></a>
An optional description for the map 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)

`MapName`  <a name="cfn-location-map-mapname"></a>
The name for the map resource.  
Requirements:  
+ Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (\$1). 
+ Must be a unique map resource name. 
+ No spaces allowed. For example, `ExampleMap`.
*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-map-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-map-tags"></a>
Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.  
Format: `"key" : "value"`  
Restrictions:  
+ Maximum 50 tags per resource
+ Each resource tag must be unique with a maximum of one value.
+ Maximum key length: 128 Unicode characters in UTF-8
+ Maximum value length: 256 Unicode characters in UTF-8
+ Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: \$1 - = . \$1 : / @. 
+ Cannot use "aws:" as a prefix for a key.
*Required*: No  
*Type*: Array of [Tag](aws-properties-location-map-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-map-return-values"></a>

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Map` 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-map-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-map-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.  
+ Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`

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

`MapArn`  <a name="MapArn-fn::getatt"></a>
Synonym for `Arn`. The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.  
+ Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`

`UpdateTime`  <a name="UpdateTime-fn::getatt"></a>
The timestamp for when the map 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::Map MapConfiguration
<a name="aws-properties-location-map-mapconfiguration"></a>

Specifies the map tile style selected from an available provider.

## Syntax
<a name="aws-properties-location-map-mapconfiguration-syntax"></a>

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

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

```
{
  "[CustomLayers](#cfn-location-map-mapconfiguration-customlayers)" : [ String, ... ],
  "[PoliticalView](#cfn-location-map-mapconfiguration-politicalview)" : String,
  "[Style](#cfn-location-map-mapconfiguration-style)" : String
}
```

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

```
  [CustomLayers](#cfn-location-map-mapconfiguration-customlayers): 
    - String
  [PoliticalView](#cfn-location-map-mapconfiguration-politicalview): String
  [Style](#cfn-location-map-mapconfiguration-style): String
```

## Properties
<a name="aws-properties-location-map-mapconfiguration-properties"></a>

`CustomLayers`  <a name="cfn-location-map-mapconfiguration-customlayers"></a>
Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as the `POI` layer for the VectorEsriNavigation style.   
Currenlty only `VectorEsriNavigation` supports CustomLayers. For more information, see [Custom Layers](https://docs.aws.amazon.com//location/latest/developerguide/map-concepts.html#map-custom-layers). 
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `100 | 10`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PoliticalView`  <a name="cfn-location-map-mapconfiguration-politicalview"></a>
Specifies the map political view selected from an available data provider.  
*Required*: No  
*Type*: String  
*Pattern*: `^[A-Z]{3}$`  
*Minimum*: `3`  
*Maximum*: `3`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Style`  <a name="cfn-location-map-mapconfiguration-style"></a>
Specifies the map style selected from an available data provider.  
Valid [Esri map styles](https://docs.aws.amazon.com/location/previous/developerguide/esri.html):  
+ `VectorEsriDarkGrayCanvas` – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content. 
+ `RasterEsriImagery` – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide. 
+ `VectorEsriLightGrayCanvas` – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content. 
+ `VectorEsriTopographic` – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.
+ `VectorEsriStreets` – The Esri Street Map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.
+ `VectorEsriNavigation` – The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
Valid [HERE Technologies map styles](https://docs.aws.amazon.com/location/previous/developerguide/HERE.html):  
+ `VectorHereContrast` – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.
**Note**  
The `VectorHereContrast` style has been renamed from `VectorHereBerlin`. `VectorHereBerlin` has been deprecated, but will continue to work in applications that use it.
+ `VectorHereExplore` – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.
+ `VectorHereExploreTruck` – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.
+ `RasterHereExploreSatellite` – A global map containing high resolution satellite imagery.
+ `HybridHereExploreSatellite` – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.
**Note**  
Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid [GrabMaps map styles](https://docs.aws.amazon.com/location/previous/developerguide/grab.html):  
+ `VectorGrabStandardLight` – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.
+ `VectorGrabStandardDark` – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region (`ap-southeast-1`). For more information, see [GrabMaps countries and area covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area).
Valid [Open Data map styles](https://docs.aws.amazon.com/location/previous/developerguide/open-data.html):  
+ `VectorOpenDataStandardLight` – The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
+ `VectorOpenDataStandardDark` – Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
+ `VectorOpenDataVisualizationLight` – The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.
+ `VectorOpenDataVisualizationDark` – The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.
*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)

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

Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

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

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

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

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

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

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

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

`Key`  <a name="cfn-location-map-tag-key"></a>
The key of the tag that is associated with the specified map.  
*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-map-tag-value"></a>
The value of the tag that is associated with the specified map.  
*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)