> **Experimental**
>
> `@aws-cdk/aws-location-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# ApiKey

An API Key.

Extends: Construct › Resource › ApiKey
Implements: IApiKey, IResource, IEnvironmentAware, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/api-key.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-location-alpha/lib/api-key.ts#L231)

## 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,
  ],
});
```

## Initializer

```ts
new ApiKey(scope: Construct, id: string, props?: ApiKeyProps)
```

## Construct Props

- `allowMapsActions`: [AllowMapsAction](/cdk/api/v2/docs/@aws-cdk_aws-location-alpha.AllowMapsAction.html)[] — A list of allowed actions for Maps that an API key resource grants permissions to perform.

  **Default:** no actions for Maps are permitted

- `allowPlacesActions`: [AllowPlacesAction](/cdk/api/v2/docs/@aws-cdk_aws-location-alpha.AllowPlacesAction.html)[] — A list of allowed actions for Places that an API key resource grants permissions to perform.

  **Default:** no actions for Places are permitted

- `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.

- `allowRoutesActions`: [AllowRoutesAction](/cdk/api/v2/docs/@aws-cdk_aws-location-alpha.AllowRoutesAction.html)[] — A list of allowed actions for Routes that an API key resource grants permissions to perform.

  **Default:** no actions for Routes are permitted

- `apiKeyName`: 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.

- `description`: string — A description for the api key.

  **Default:** no description

- `expireTime`: date — 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`.

- `forceDelete`: boolean — `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.

- `forceUpdate`: boolean — 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.

- `noExpiry`: boolean — 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`.

## Properties

- `apiKeyArn`: string — The Amazon Resource Name (ARN) of the api key resource.

- `apiKeyCreateTime`: string — The timestamp for when the api key resource was created in ISO 8601 format.

- `apiKeyName`: string — The name of the api key.

- `apiKeyUpdateTime`: string — The timestamp for when the api key resource was last updated in ISO 8601 format.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromApiKeyArn(scope: Construct, id: string, apiKeyArn: string): IApiKey` (static) — Use an existing api key by ARN.

- `fromApiKeyName(scope: Construct, id: string, apiKeyName: string): IApiKey` (static) — Use an existing api key by name.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.