AWS apigateway documentation change
Summary
Removed configuration steps section and updated API key documentation links
Security assessment
The changes restructure documentation by removing redundant procedural steps and updating links, but do not introduce or modify security controls. API key usage remains documented as an existing security feature without substantive changes.
Diff
diff --git a/apigateway/latest/developerguide/api-gateway-api-usage-plans.md b/apigateway/latest/developerguide/api-gateway-api-usage-plans.md index 0c9cbdeb9..1bb88a0cb 100644 --- a//apigateway/latest/developerguide/api-gateway-api-usage-plans.md +++ b//apigateway/latest/developerguide/api-gateway-api-usage-plans.md @@ -5 +5 @@ -What are usage plans and API keys?Steps to configure a usage plan and API keys in API GatewayBest practices for API keys and usage plans +What are usage plans and API keys?Best practices for API keys and usage plans @@ -15 +15 @@ A _usage plan_ specifies who can access one or more deployed API stages and meth -_API keys_ are alphanumeric string values that you distribute to application developer customers to grant access to your API. You can use API keys together with [Lambda authorizers](./apigateway-use-lambda-authorizer.html), [IAM roles](./permissions.html), or [Amazon Cognito](./apigateway-integrate-with-cognito.html) to control access to your APIs. API Gateway can generate API keys on your behalf, or you can import them from a [CSV file](./api-key-file-format.html). You can generate an API key in API Gateway, or import it into API Gateway from an external source. For more information, see [Set up API keys using the API Gateway console](./api-gateway-setup-api-key-with-console.html). +_API keys_ are alphanumeric string values that you distribute to application developer customers to grant access to your API. You can use API keys together with [Lambda authorizers](./apigateway-use-lambda-authorizer.html), [IAM roles](./permissions.html), or [Amazon Cognito](./apigateway-integrate-with-cognito.html) to control access to your APIs. API Gateway can generate API keys on your behalf, or you can import them from a [CSV file](./api-key-file-format.html). You can generate an API key in API Gateway, or import it into API Gateway from an external source. For more information, see [Set up API keys for REST APIs in API Gateway](./api-gateway-setup-api-keys.html). @@ -35,27 +34,0 @@ Usage plan throttling and quotas are not hard limits, and are applied on a best- -## Steps to configure a usage plan and API keys in API Gateway - -The following tasks outline the required steps to configure a usage plan and API keys. For best practices, see Best practices for API keys and usage plans. - -###### To configure a usage plan and API keys - - 1. Create an API and configure the method request for each API method to require an API key. Then, deploy your API to a stage. - -To include API methods in a usage plan, you must configure individual API methods to require an API key. - -For more information about how to configure a method to require an API key, see [Require an API key on a method](./api-gateway-setup-api-key-with-console.html#api-gateway-usage-plan-configure-apikey-on-method). - - 2. Generate or import API keys to distribute to application developers (your customers) who will be using your API. API keys are required for your usage plan. - -For more information about how to generate or import API keys, see [Create an API key](./api-gateway-setup-api-key-with-console.html#api-gateway-usage-plan-create-apikey). - - 3. Create the usage plan with the desired throttle and quota limits, and then associate API stages and API keys with the usage plan. - -For more information about how to create the usage plan, see [Create a usage plan](./api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-create). - - - - -Callers of the API must supply an assigned API key in the `x-api-key` header in requests to the API. - -For a complete AWS CloudFormation template that creates and associates a usage plan with a new stage and an API key, see [Create and configure API keys and usage plans with AWS CloudFormation](./api-key-usage-plan-cfn.html). -