CfnMapProps

class aws_cdk.aws_location.CfnMapProps(*, configuration, map_name, description=None, pricing_plan=None)

Bases: object

Properties for defining a CfnMap.

Parameters:

  • configuration (Union[MapConfigurationProperty, Dict[str, Any], IResolvable]) – 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.

  • map_name (str) – 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 (Optional[str]) – An optional description for the map resource.

  • pricing_plan (Optional[str]) – No longer used. If included, the only allowed value is RequestBasedUsage . Allowed Values : RequestBasedUsage

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_location as location

cfn_map_props = location.CfnMapProps(
    configuration=location.CfnMap.MapConfigurationProperty(
        style="style"
    ),
    map_name="mapName",

    # the properties below are optional
    description="description",
    pricing_plan="pricingPlan"
)

Attributes

configuration

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-configuration

description

An optional description for the map resource.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-description

map_name

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-mapname

pricing_plan

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

Allowed Values : RequestBasedUsage

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-map.html#cfn-location-map-pricingplan