Resource Type: AWS > API Gateway > API Key

The API Key resource type in API Gateway is a managed authentication mechanism used to control and restrict access to APIs. It enables secure API consumption by associating unique keys with applications, enforcing rate limits, and enhancing traffic management for better security and scalability.

Resource Context

API Key is a part of the API Gateway service.

Each API Key lives under a Region.

Controls

The primary controls for AWS > API Gateway > API Key are:

Quick Actions

In Your Workspace

Developers

Resource Type URI

tmod:@turbot/aws-apigateway#/resource/types/apiKey

Category URI

tmod:@turbot/turbot#/resource/categories/applicationIntegration

GraphQL

query resource(id: "tmod:@turbot/aws-apigateway#/resource/types/apiKey") { … }

query resourceActivities(filter: "resourceId:'tmod:@turbot/aws-apigateway#/resource/types/apiKey'") { … }

mutation createResource(input: { … })

mutation updateResource(input: { … })

CLI

Get Resource

turbot graphql resource --id "tmod:@turbot/aws-apigateway#/resource/types/apiKey"

Steampipe Query

Get Resource

select * from guardrails_resource where resource_type_uri = 'tmod:@turbot/aws-apigateway#/resource/types/apiKey';

Get Policy Settings (By Resource ID)

select * from guardrails_policy_setting where filter = 'resourceTypeId:"tmod:@turbot/aws-apigateway#/resource/types/apiKey"';

Get Resource Notification

select * from guardrails_notification where resource_type_uri = 'tmod:@turbot/aws-apigateway#/resource/types/apiKey' and notification_type in ('resource_updated', 'resource_created');