api_key

Gets an individual api_key resource

Overview

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

Fields

Name	Datatype	Description
api_key_id	string
customer_id	string	An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
description	string	The description of the ApiKey.
enabled	boolean	Specifies whether the ApiKey can be used by callers.
generate_distinct_id	boolean	Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> 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	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
tags	array	The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
value	string	Specifies a value of the API key.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
api_key_id,
customer_id,
description,
enabled,
generate_distinct_id,
name,
stage_keys,
tags,
value
FROM awscc.apigateway.api_key
WHERE data__Identifier = '<APIKeyId>';

Permissions

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

Read

apigateway:GET

Update

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

Delete

apigateway:DELETE,
apigateway:GET