Input properties for creating a UsagePlan and associated API Keys.

interface APIKeyArgs {
    apiKeys?: any[];
    apis?: API[];
    usagePlan?: any;
}

Properties

apiKeys?: any[]

The API keys you would like to create & associate with the usage plan. You can pass an array that has a combination of:

  1. an existing APIKey
  2. ApiKeyArgs for a new APIKey
apis?: API[]

Define the apis you would like to associate the usage plan with. This can be used in place of defining the apiStages defined in the [usagePlan]. You cannot define both [apis] and [usagePlan.apiStages].

usagePlan?: any

Define the usage plan to create. You can either define:

  1. an existing Usage Plan - the API Keys will be associated with the usage plan
  2. UsagePlanArgs with [usagePlan.apiStages] defined to define a new Usage Plan
  3. UsagePlanArgs with [apis] defined and [usagePlan.apiStages] NOT defined to define a new Usage Plan
  4. Nothing - if you do not specify [apis] and pass in an empty object, a new usage plan will be created on your behalf with the all the default values.

Generated using TypeDoc