Skip to content

[AWS::Location::APIKey] - [Docs] - add Enhanced API Actions and Resources to ApiKeyRestrictions #2225

Open
@mazyu36

Description

@mazyu36

Name of the resource

AWS::Location::APIKey

Resource name

No response

Reference Link

https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-properties-location-apikey-apikeyrestrictions.html#cfn-location-apikey-apikeyrestrictions-allowactions

Details

Amazon Location Service launches Enhanced Places, Routes, and Maps. Ref

However, in the API Key CloudFormation documentation, the descriptions of AllowActions and AllowResources only cover legacy APIs, not enhanced APIs.
The documentation should include information about Enhanced APIs.

Ref

I successfully deployed an API Key with Enhanced APIs Actions and Resources.
Therefore, this appears to be solely a documentation issue.

  APIKey:
    Type: AWS::Location::APIKey
    Properties:
      Description: my api key for test
      ExpireTime: '2026-01-01T00:00:00.000Z'
      KeyName: my-api-key
      NoExpiry: false
      Restrictions:
        AllowActions:
          - geo-maps:GetStaticMap
          - geo-maps:GetTile
          - geo-places:Autocomplete
          - geo-places:Geocode
          - geo-places:GetPlace
          - geo-places:ReverseGeocode
          - geo-places:SearchNearby
          - geo-places:SearchText
          - geo-places:Suggest
          - geo-routes:CalculateIsolines
          - geo-routes:CalculateRoutes
          - geo-routes:CalculateRouteMatrix
          - geo-routes:OptimizeWaypoints
          - geo-routes:SnapToRoads
        AllowReferers:
          - https://example.com
        AllowResources:
          - arn:aws:geo-maps:us-east-1::provider/default
          - arn:aws:geo-places:us-east-1::provider/default
          - arn:aws:geo-routes:us-east-1::provider/default

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions