API Gateway: Custom API key value and API key export

[alexarb]

• I'm submitting a ...
  • 🪲 bug report
  • 🚀 feature request
  • 📚 construct library gap
  • ☎️ security issue or vulnerability => Please see policy
  • ❓ support request => Please see note at the top of this template.

Please add possibility to add custom value and modification for API key in API Gateway.
This feature supported by CFN - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value

Also there is need to be able to import existing API keys. For example to be able to migrate to CDK from CFN or manually created resources. And cross-stack interactions.

[SomayaB]

Hi @alexarb, thanks for submitting a feature request! We will look into this and someone will update this issue when there is movement.

[johnmarian]

This is my temporary fix that I'm using in the meantime (just to be able to read the value into CDK):

import { Construct, IResource as IResourceBase, Resource } from "@aws-cdk/core";
import {
  CfnApiKey,
  ResourceOptions,
  RestApi,
  IApiKey,
  ApiKey,
  ApiKeyProps
} from "@aws-cdk/aws-apigateway";

/**
 * API keys are alphanumeric string values that you distribute to
 * app developer customers to grant access to your API
 */
export interface IApiKeyWithValue extends IApiKey {
  /**
   * The API key value.
   * @attribute
   */
  readonly value: string | undefined;
}

/**
 * An API Gateway ApiKey with value prperty.
 *
 * An ApiKey can be distributed to API clients that are executing requests
 * for Method resources that require an Api Key.
 */
export class ApiKeyWithValue extends Resource implements IApiKeyWithValue {
  public readonly value: string | undefined;
  public readonly keyId: string;

  constructor(scope: Construct, id: string, props: ApiKeyProps = {}) {
    super(scope, id, {
      physicalName: props.apiKeyName
    });

    const resource = new CfnApiKey(this, "Resource", {
      customerId: props.customerId,
      description: props.description,
      enabled: props.enabled || true,
      generateDistinctId: props.generateDistinctId,
      name: this.physicalName,
      stageKeys: this.renderStageKeys(props.resources)
    });

    this.keyId = resource.ref;
    this.value = resource.value;
  }

  private renderStageKeys(
    resources: RestApi[] | undefined
  ): CfnApiKey.StageKeyProperty[] | undefined {
    if (!resources) {
      return undefined;
    }

    return resources.map((resource: RestApi) => {
      const restApi = resource;
      const restApiId = restApi.restApiId;
      const stageName = restApi.deploymentStage!.stageName.toString();
      return { restApiId, stageName };
    });
  }
}

[diogo-ap-old]

Hi. Is there any update on this request? Having the ability to specify the API Key value is important for us, but it is not supported by CDK: