api_keys

Creates, updates, deletes or gets an api_key resource or lists api_keys in a region

Overview

Name	api_keys
Type	Resource
Description	The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.
Id	awscc.apigateway.api_keys

Fields

get (all properties)

Name	Datatype	Description
api_key_id	string
customer_id	string
description	string
enabled	boolean
generate_distinct_id	boolean
name	string	A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
▶stage_keys	array
▶tags	array
value	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
api_key_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	api_keys	INSERT	region
delete_resource	api_keys	DELETE	Identifier, region
update_resource	api_keys	UPDATE	Identifier, PatchDocument, region
list_resources	api_keys_list_only	SELECT	region
get_resource	api_keys	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual api_key.

SELECT
  region,
  api_key_id,
  customer_id,
  description,
  enabled,
  generate_distinct_id,
  name,
  stage_keys,
  tags,
  value
FROM awscc.apigateway.api_keys
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_key_id }}';

list (identifiers only)

Lists all api_keys in a region.

SELECT
  region,
  api_key_id
FROM awscc.apigateway.api_keys_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.api_keys (
  CustomerId,
  Description,
  Enabled,
  GenerateDistinctId,
  Name,
  StageKeys,
  Tags,
  Value,
  region
)
SELECT
  '{{ customer_id }}',
  '{{ description }}',
  '{{ enabled }}',
  '{{ generate_distinct_id }}',
  '{{ name }}',
  '{{ stage_keys }}',
  '{{ tags }}',
  '{{ value }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.api_keys (
  CustomerId,
  Description,
  Enabled,
  GenerateDistinctId,
  Name,
  StageKeys,
  Tags,
  Value,
  region
)
SELECT
  '{{ customer_id }}',
  '{{ description }}',
  '{{ enabled }}',
  '{{ generate_distinct_id }}',
  '{{ name }}',
  '{{ stage_keys }}',
  '{{ tags }}',
  '{{ value }}',
  '{{ 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: api_key
  props:
    - name: customer_id
      value: '{{ customer_id }}'
    - name: description
      value: '{{ description }}'
    - name: enabled
      value: '{{ enabled }}'
    - name: generate_distinct_id
      value: '{{ generate_distinct_id }}'
    - name: name
      value: '{{ name }}'
    - name: stage_keys
      value:
        - rest_api_id: '{{ rest_api_id }}'
          stage_name: '{{ stage_name }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: value
      value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a api_key resource, using stack-deploy.

/*+ update */
UPDATE awscc.apigateway.api_keys
SET PatchDocument = string('{{ {
    "CustomerId": customer_id,
    "Description": description,
    "Enabled": enabled,
    "StageKeys": stage_keys,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_key_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.api_keys
WHERE
  Identifier = '{{ api_key_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 api_keys resource, the following permissions are required:

Create

apigateway:POST,
apigateway:GET,
apigateway:PUT

Read

apigateway:GET

Update

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

Delete

apigateway:DELETE,
apigateway:GET

List

apigateway:GET