Skip to content
v2.274.0

Experimental

@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

MapProps Struct ​

Properties for the Amazon Location Service Map.

Example ​

ts
new location.Map(this, 'Map', {
  mapName: 'my-map',
  style: location.Style.VECTOR_ESRI_NAVIGATION,
  customLayers: [location.CustomLayer.POI],
});

Properties ​

customLayersoptionalCustomLayer[]custom_layersoptionaltyping.List[CustomLayer]customLayersoptionalList<CustomLayer>CustomLayersoptionalCustomLayer[]CustomLayersoptional*[]CustomLayer#
Specifies the custom layers for the style.

Default: no custom layers

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description for the map.

Default: no description

mapNameoptionalstringmap_nameoptionalstrmapNameoptionalStringMapNameoptionalstringMapNameoptional*string#
A name for the map.

Default: A name is automatically generated

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

politicalViewoptionalPoliticalViewpolitical_viewoptionalPoliticalViewpoliticalViewoptionalPoliticalViewPoliticalViewoptionalPoliticalViewPoliticalViewoptionalPoliticalView#
Specifies the map political view selected from an available data provider.

Default: no political view

notes

The political view must be used in compliance with applicable laws, including those laws about mapping of the country or region where the maps, images, and other data and third-party content which you access through Amazon Location Service is made available.

styleStylestyleStylestyleStyleStyleStyleStyleStylerequired#
Specifies the map style selected from an available data provider.