Class: ApiKey

ApiGateway.ApiKey

new ApiKey()

Properties:
Name Type Description
Description String Required: No. A description of the purpose of the API key.Update requires: No interruption
Enabled Boolean Required: No. Indicates whether the API key can be used by clients.Update requires: No interruption
Name String Required: No. A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type.ImportantIf you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.Update requires: Replacement
StageKeys AmazonAPIGatewayApiKeyStageKey Required: No. A list of stages to associated with this API key.Update requires: No interruption
Source:

Extends

  • WKResource

ApiGateway.ApiKey

new ApiKey()

Properties:
Name Type Description
Description String Required: No. A description of the purpose of the API key.Update requires: No interruption
Enabled Boolean Required: No. Indicates whether the API key can be used by clients.Update requires: No interruption
Name String Required: No. A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type.ImportantIf you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.Update requires: Replacement
StageKeys AmazonAPIGatewayApiKeyStageKey Required: No. A list of stages to associated with this API key.Update requires: No interruption
Source:

Extends

  • WKResource