AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ApiKeyProps Struct ​

Properties for an API Key.

Stability
Experimental
Source
lib/api-key.ts

Example ​

ts
new location.ApiKey(this, 'APIKeyAny', {
  // specify allowed actions
  allowMapsActions: [
    location.AllowMapsAction.GET_STATIC_MAP,
  ],
  allowPlacesActions: [
    location.AllowPlacesAction.GET_PLACE,
  ],
  allowRoutesActions: [
    location.AllowRoutesAction.CALCULATE_ISOLINES,
  ],
});

Properties ​

allowMapsActionsAllowMapsAction[]allow_maps_actionstyping.List[AllowMapsAction]allowMapsActionsList<AllowMapsAction>AllowMapsActionsAllowMapsAction[]AllowMapsActions*[]AllowMapsAction= no actions for Maps are permitte…#
A list of allowed actions for Maps that an API key resource grants permissions to perform.
default

Default: no actions for Maps are permitted

allowPlacesActionsAllowPlacesAction[]allow_places_actionstyping.List[AllowPlacesAction]allowPlacesActionsList<AllowPlacesAction>AllowPlacesActionsAllowPlacesAction[]AllowPlacesActions*[]AllowPlacesAction= no actions for Places are permit…#
A list of allowed actions for Places that an API key resource grants permissions to perform.
default

Default: no actions for Places are permitted

allowReferersstring[]allow_refererstyping.List[str]allowReferersList<String>AllowReferersstring[]AllowReferers*[]*string= no Referer#
An optional list of allowed HTTP referers for which requests must originate from.

Requests using this API key from other domains will not be allowed.

allowRoutesActionsAllowRoutesAction[]allow_routes_actionstyping.List[AllowRoutesAction]allowRoutesActionsList<AllowRoutesAction>AllowRoutesActionsAllowRoutesAction[]AllowRoutesActions*[]AllowRoutesAction= no actions for Routes are permit…#
A list of allowed actions for Routes that an API key resource grants permissions to perform.
default

Default: no actions for Routes are permitted

apiKeyNamestringapi_key_namestrapiKeyNameStringApiKeyNamestringApiKeyName*string= A name is automatically generate…#
A name for the api key.

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

Must be a unique API key name.

default

Default: A name is automatically generated

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#
A description for the api key.
expireTimedateexpire_timedatetimeexpireTimeInstantExpireTimeDateTimeExpireTime*time.Time= undefined - The API Key never ex…#
The optional timestamp for when the API key resource will expire.

expireTime must be set when noExpiry is false or undefined. When expireTime is not set, noExpiry must be true.

default

Default: undefined - The API Key never expires

forceDeletebooleanforce_deleteboolforceDeleteBooleanForceDeleteboolForceDelete*bool= undefined - not force delete#
`forceDelete` bypasses an API key's expiry conditions and deletes the key.

Set the parameter true to delete the key or to false to not preemptively delete the API key.

forceUpdatebooleanforce_updateboolforceUpdateBooleanForceUpdateboolForceUpdate*bool= undefined - not force update#
The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.

noExpirybooleanno_expiryboolnoExpiryBooleanNoExpiryboolNoExpiry*bool= undefined - The API Key expires …#
Whether the API key should expire.

Set to true when expireTime is not set. When you set expireTime, noExpiry must be false or undefined.

default

Default: undefined - The API Key expires at expireTime