aws-cdk-lib.aws_location.CfnMapProps

CfnMapProps Struct

Properties for defining a CfnMap.

Source

Generated code

Type last changed

v2.119.0 · 11 Jan 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_location as location } from 'aws-cdk-lib';
const cfnMapProps: location.CfnMapProps = {
  configuration: {
    style: 'style',

    // the properties below are optional
    customLayers: ['customLayers'],
    politicalView: 'politicalView',
  },
  mapName: 'mapName',

  // the properties below are optional
  description: 'description',
  pricingPlan: 'pricingPlan',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

configurationIResolvable | CfnMap.MapConfigurationPropertyconfigurationtyping.Union[IResolvable, MapConfigurationProperty]configurationIResolvableConfigurationIResolvableConfigurationinterface{}required#

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.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

An optional description for the map resource.

mapNamestringmap_namestrmapNameStringMapNamestringMapName*stringrequired#

The name for the map resource.

Requirements:

• Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
• Must be a unique map resource name.
• No spaces allowed. For example, ExampleMap .

pricingPlanstringpricing_planstrpricingPlanStringPricingPlanstringPricingPlan*string#

No longer used. If included, the only allowed value is `RequestBasedUsage` .

Allowed Values : RequestBasedUsage

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

Applies one or more tags to the map resource.

notes

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: + - = . _ : /

Used as props by

• CfnMap