Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mazyu36 opened this issue Jan 4, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mazyu36
Copy link

mazyu36 commented Jan 4, 2025

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
@mazyu36 mazyu36 added the documentation Improvements or additions to documentation label Jan 4, 2025
@mazyu36 mazyu36 changed the title [AWS::Location::APIKey] - [Docs] - should note about Enhanced API Actions and Resources on ApiKeyRestrictions [AWS::Location::APIKey] - [Docs] - add Enhanced API Actions and Resources to ApiKeyRestrictions Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant