Package software.amazon.awscdk.services.location

Interface CfnMapProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMapProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:04.222Z")
@Stability(Stable)
public interface CfnMapProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.location.*;
 CfnMapProps cfnMapProps = CfnMapProps.builder()
         .configuration(MapConfigurationProperty.builder()
                 .style("style")
                 // the properties below are optional
                 .customLayers(List.of("customLayers"))
                 .politicalView("politicalView")
                 .build())
         .mapName("mapName")
         // the properties below are optional
         .description("description")
         .pricingPlan("pricingPlan")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMapProps.Builder	A builder for CfnMapProps
static final class	CfnMapProps.Jsii$Proxy	An implementation for CfnMapProps

Method Summary

Modifier and Type	Method	Description
static CfnMapProps.Builder	builder()
Object	getConfiguration()	Specifies the MapConfiguration , including the map style, for the map resource that you create.
default String	getDescription()	An optional description for the map resource.
String	getMapName()	The name for the map resource.
default String	getPricingPlan()	No longer used.
default List<CfnTag>	getTags()	Applies one or more tags to the map resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfiguration

@Stability(Stable)
@NotNull
Object getConfiguration()

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.

See Also:

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

getMapName

@Stability(Stable)
@NotNull
String getMapName()

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 .

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

An optional description for the map resource.

See Also:

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

getPricingPlan

@Stability(Stable)
@Nullable
default String getPricingPlan()

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

Allowed Values : RequestBasedUsage

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnMapProps.Builder builder()

Returns:

a CfnMapProps.Builder of CfnMapProps