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#
A list of allowed actions for Maps that an API key resource grants permissions to perform.

Default: no actions for Maps are permitted

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

Default: no actions for Places are permitted

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

Default: no Referer

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

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

Default: no actions for Routes are permitted

apiKeyNamestringapi_key_namestrapiKeyNameStringApiKeyNamestringApiKeyName*string#
A name for the api key.

Default: A name is automatically generated

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

Must be a unique API key name.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
A description for the api key.

Default: no description

expireTimedateexpire_timedatetimeexpireTimeInstantExpireTimeDateTimeExpireTime*time.Time#
The optional timestamp for when the API key resource will expire.

Default: undefined - The API Key never expires

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

forceDeletebooleanforce_deleteboolforceDeleteBooleanForceDeleteboolForceDelete*bool#
`forceDelete` bypasses an API key's expiry conditions and deletes the key.

Default: undefined - not force delete

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

forceUpdatebooleanforce_updateboolforceUpdateBooleanForceUpdateboolForceUpdate*bool#
The boolean flag to be included for updating ExpireTime or Restrictions details.

Default: undefined - not force update

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#
Whether the API key should expire.

Default: undefined - The API Key expires at expireTime

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