maps

Creates, updates, deletes or gets a map resource or lists maps in a region

Overview

Name	maps
Type	Resource
Description	Definition of AWS::Location::Map Resource Type
Id	awscc.location.maps

Fields

get (all properties)

Name	Datatype	Description
▶configuration	object
create_time	string	The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
description	string
map_arn	string
map_name	string
pricing_plan	string
▶tags	array	An array of key-value pairs to apply to this resource.
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
map_name	string
region	string	AWS region.

For more information, see AWS::Location::Map.

Methods

Name	Resource	Accessible by	Required Params
create_resource	maps	INSERT	Configuration, MapName, region
delete_resource	maps	DELETE	Identifier, region
update_resource	maps	UPDATE	Identifier, PatchDocument, region
list_resources	maps_list_only	SELECT	region
get_resource	maps	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual map.

SELECT
  region,
  configuration,
  create_time,
  description,
  map_arn,
  map_name,
  pricing_plan,
  tags,
  update_time,
  arn
FROM awscc.location.maps
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ map_name }}';

list (identifiers only)

Lists all maps in a region.

SELECT
  region,
  map_name
FROM awscc.location.maps_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new map resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.location.maps (
  Configuration,
  MapName,
  region
)
SELECT
  '{{ configuration }}',
  '{{ map_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.location.maps (
  Configuration,
  Description,
  MapName,
  PricingPlan,
  Tags,
  region
)
SELECT
  '{{ configuration }}',
  '{{ description }}',
  '{{ map_name }}',
  '{{ pricing_plan }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: map
    props:
      - name: configuration
        value:
          style: '{{ style }}'
          political_view: '{{ political_view }}'
          custom_layers:
            - '{{ custom_layers[0] }}'
      - name: description
        value: '{{ description }}'
      - name: map_name
        value: '{{ map_name }}'
      - name: pricing_plan
        value: '{{ pricing_plan }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a map resource, using stack-deploy.

/*+ update */
UPDATE awscc.location.maps
SET PatchDocument = string('{{ {
    "Description": description,
    "PricingPlan": pricing_plan,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ map_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.location.maps
WHERE
  Identifier = '{{ map_name }}' AND
  region = 'us-east-1';

Permissions

To operate on the maps resource, the following permissions are required:

Create

geo:CreateMap,
geo:DescribeMap,
geo:TagResource,
geo:UntagResource

Read

geo:DescribeMap

Update

geo:CreateMap,
geo:DescribeMap,
geo:TagResource,
geo:UntagResource,
geo:UpdateMap

Delete

geo:DeleteMap,
geo:DescribeMap

List

geo:ListMaps