usage_plan

Gets an individual usage_plan resource

Overview

Name	usage_plan
Type	Resource
Description	usage_plan
Id	awscc.apigateway.usage_plan

Fields

Name	Datatype	Description
id	string
api_stages	array	The associated API stages of a usage plan.
description	string	The description of a usage plan.
quota	object	The target maximum number of permitted requests per a given unit time interval.
tags	array	The collection of tags. Each tag element is associated with a given resource.
throttle	object	A map containing method level throttling information for API stage in a usage plan.
usage_plan_name	string	The name of a usage plan.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
id,
api_stages,
description,
quota,
tags,
throttle,
usage_plan_name
FROM awscc.apigateway.usage_plan
WHERE data__Identifier = '<Id>';

Permissions

To operate on the usage_plan resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:GET,
apigateway:DELETE,
apigateway:PATCH,
apigateway:PUT

Delete

apigateway:DELETE,
apigateway:GET,
apigateway:PATCH