Package software.amazon.awscdk.services.location

Class CfnMap

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.location.CfnMap
All Implemented Interfaces:
IInspectable, ITaggableV2, IMapRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:43.056Z") @Stability(Stable) public class CfnMap extends CfnResource implements IInspectable, IMapRef, ITaggableV2
The AWS::Location::Map resource specifies a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

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.*;
 CfnMap cfnMap = CfnMap.Builder.create(this, "MyCfnMap")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMap

      protected CfnMap(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMap

      protected CfnMap(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMap

      @Stability(Stable) public CfnMap(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMapProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromMapArn

      @Stability(Stable) @NotNull public static IMapRef fromMapArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IMapRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromMapName

      @Stability(Stable) @NotNull public static IMapRef fromMapName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String mapName)
      Creates a new IMapRef from a mapName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      mapName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

      • Format example: arn:aws:geo:region:account-id:maps/ExampleMap

    • getAttrCreateTime

      @Stability(Stable) @NotNull public String getAttrCreateTime()
      The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getAttrDataSource

      @Stability(Stable) @NotNull public String getAttrDataSource()

    • getAttrMapArn

      @Stability(Stable) @NotNull public String getAttrMapArn()
      Synonym for Arn .

      The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS .

      • Format example: arn:aws:geo:region:account-id:maps/ExampleMap

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public String getAttrUpdateTime()
      The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMapRef

      @Stability(Stable) @NotNull public MapReference getMapRef()
      A reference to a Map resource.
      Specified by:
      getMapRef in interface IMapRef

    • getConfiguration

      @Stability(Stable) @NotNull public Object getConfiguration()
      Specifies the MapConfiguration , including the map style, for the map resource that you create.

      Returns union: either IResolvable or CfnMap.MapConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull IResolvable value)
      Specifies the MapConfiguration , including the map style, for the map resource that you create.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull CfnMap.MapConfigurationProperty value)
      Specifies the MapConfiguration , including the map style, for the map resource that you create.

    • getMapName

      @Stability(Stable) @NotNull public String getMapName()
      The name for the map resource.

    • setMapName

      @Stability(Stable) public void setMapName(@NotNull String value)
      The name for the map resource.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description for the map resource.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description for the map resource.

    • getPricingPlan

      @Stability(Stable) @Nullable public String getPricingPlan()
      No longer used.

      If included, the only allowed value is RequestBasedUsage .

    • setPricingPlan

      @Stability(Stable) public void setPricingPlan(@Nullable String value)
      No longer used.

      If included, the only allowed value is RequestBasedUsage .

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Applies one or more tags to the map resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Applies one or more tags to the map resource.