interface CfnMapProps

Language	Type name
.NET	`Amazon.CDK.AWS.Location.CfnMapProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslocation#CfnMapProps`
Java	`software.amazon.awscdk.services.location.CfnMapProps`
Python	`aws_cdk.aws_location.CfnMapProps`
TypeScript	`aws-cdk-lib` » `aws_location` » `CfnMapProps`

Properties for defining a CfnMap.

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

Name	Type	Description
configuration	`IResolvable` `\|` `MapConfigurationProperty`	Specifies the `MapConfiguration` , including the map style, for the map resource that you create.
mapName	`string`	The name for the map resource.
description?	`string`	An optional description for the map resource.
pricingPlan?	`string`	No longer used. If included, the only allowed value is `RequestBasedUsage` .
tags?	`CfnTag[]`	Applies one or more tags to the map resource.

configuration

Type: IResolvable | MapConfigurationProperty

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.

mapName

Type: string

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 .

description?

Type: string (optional)

An optional description for the map resource.

pricingPlan?

Type: string (optional)

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

Allowed Values : RequestBasedUsage

tags?

Type: CfnTag[] (optional)

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