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	awscc.apigateway.usage_plan_keys

Fields

get (all properties)

Name	Datatype	Description
key_id	string	The Id of the UsagePlanKey resource.
key_type	string
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.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::ApiGateway::UsagePlanKey.

Methods

Name	Resource	Accessible by	Required Params
create_resource	usage_plan_keys	INSERT	KeyType, UsagePlanId, KeyId, region
delete_resource	usage_plan_keys	DELETE	Identifier, region
list_resources	usage_plan_keys_list_only	SELECT	region
get_resource	usage_plan_keys	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual usage_plan_key.

SELECT
  region,
  key_id,
  key_type,
  usage_plan_id,
  id
FROM awscc.apigateway.usage_plan_keys
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all usage_plan_keys in a region.

SELECT
  region,
  id
FROM awscc.apigateway.usage_plan_keys_list_only
WHERE
  region = '{{ region }}';

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 awscc.apigateway.usage_plan_keys (
  KeyId,
  KeyType,
  UsagePlanId,
  region
)
SELECT
  '{{ key_id }}',
  '{{ key_type }}',
  '{{ usage_plan_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.usage_plan_keys (
  KeyId,
  KeyType,
  UsagePlanId,
  region
)
SELECT
  '{{ key_id }}',
  '{{ key_type }}',
  '{{ usage_plan_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: key_id
      value: '{{ key_id }}'
    - name: key_type
      value: '{{ key_type }}'
    - name: usage_plan_id
      value: '{{ usage_plan_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.usage_plan_keys
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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