usage_plan_keys

Creates, updates, deletes or gets an usage_plan_key resource or lists usage_plan_keys in a region

Overview

Name	usage_plan_keys
Type	Resource
Description	The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
Id	aws.apigateway.usage_plan_keys

Fields

Name	Datatype	Description
key_id	string	The Id of the UsagePlanKey resource.
key_type	string	The type of a UsagePlanKey resource for a plan customer.
usage_plan_id	string	The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
id	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	KeyType, UsagePlanId, KeyId, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all usage_plan_keys in a region.

SELECT
region,
key_id,
key_type,
usage_plan_id,
id
FROM aws.apigateway.usage_plan_keys
WHERE region = 'us-east-1';

Gets all properties from an individual usage_plan_key.

SELECT
region,
key_id,
key_type,
usage_plan_id,
id
FROM aws.apigateway.usage_plan_keys
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new usage_plan_key resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.apigateway.usage_plan_keys (
 KeyId,
 KeyType,
 UsagePlanId,
 region
)
SELECT 
'{{ KeyId }}',
 '{{ KeyType }}',
 '{{ UsagePlanId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apigateway.usage_plan_keys (
 KeyId,
 KeyType,
 UsagePlanId,
 region
)
SELECT 
 '{{ KeyId }}',
 '{{ KeyType }}',
 '{{ UsagePlanId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: usage_plan_key
    props:
      - name: KeyId
        value: '{{ KeyId }}'
      - name: KeyType
        value: '{{ KeyType }}'
      - name: UsagePlanId
        value: '{{ UsagePlanId }}'

DELETE example

/*+ delete */
DELETE FROM aws.apigateway.usage_plan_keys
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

apigateway:POST,
apigateway:GET

Read

apigateway:GET

Delete

apigateway:DELETE,
apigateway:GET

List

apigateway:GET