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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Location::Map",
"Properties" : {
"Configuration" : MapConfiguration,
"Description" : String,
"MapName" : String,
"PricingPlan" : String,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::Location::Map
Properties:
Configuration:
MapConfiguration
Description: String
MapName: String
PricingPlan: String
Tags:
- Tag
Properties
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.Required: Yes
Type: MapConfiguration
Update requires: Replacement
Description-
An optional description for the map resource.
Required: No
Type: String
Minimum:
0Maximum:
1000Update requires: No interruption
MapName-
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.
Required: Yes
Type: String
Pattern:
^[-._\w]+$Minimum:
1Maximum:
100Update requires: Replacement
-
PricingPlan-
No longer used. If included, the only allowed value is
RequestBasedUsage.Allowed Values:
RequestBasedUsageRequired: No
Type: String
Allowed values:
RequestBasedUsageUpdate requires: No interruption
-
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: + - = . _ : / @.
-
Cannot use "aws:" as a prefix for a key.
Required: No
Type: Array of Tag
Minimum:
0Maximum:
200Update requires: No interruption
-
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Map name.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
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
-
CreateTime-
The timestamp for when the map resource was created in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ. MapArn-
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
-
UpdateTime-
The timestamp for when the map resource was last updated in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
