AWS Fundamentals Logo
AWS Fundamentals
AWS::Location::APIKey

Location APIKey

Definition of AWS::Location::APIKey Resource Type

Properties

8 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
KeyName
string
RequiredCreate-only
Restrictions
ApiKeyRestrictions
Required
Description
string
ExpireTime
string
ForceDelete
boolean
Write-only
ForceUpdate
boolean
Write-only
NoExpiry
boolean
Write-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
CreateTimestring-
KeyArnstring-
UpdateTimestring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Location::APIKey

Resources:
  MyResource:
    Type: AWS::Location::APIKey
    Properties:
      KeyName: "my-keyname"
      Restrictions: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

geo:CreateKeygeo:DescribeKeygeo:TagResourcegeo:UntagResourcegeo:GetMapTilegeo:GetMapStyleDescriptorgeo:GetMapSpritesgeo:GetMapGlyphs

delete

geo:DeleteKeygeo:DescribeKey

list

geo:ListKeys

read

geo:DescribeKey

update

geo:CreateKeygeo:DescribeKeygeo:TagResourcegeo:UntagResourcegeo:GetMapTilegeo:GetMapStyleDescriptorgeo:GetMapSpritesgeo:GetMapGlyphs

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceLocation
Properties12
Required2
TaggingSupported
Primary IDKeyName

Supported Operations

CreateDeleteListReadUpdate

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

KeyName

Related Resources

External Links