---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_apigateway_api_key Resource - terraform-provider-awscc"
subcategory: ""
description: |-
  Resource Type definition for AWS::ApiGateway::ApiKey
---

# awscc_apigateway_api_key (Resource)

Resource Type definition for AWS::ApiGateway::ApiKey



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `customer_id` (String) An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
- `description` (String) A description of the purpose of the API key.
- `enabled` (Boolean) Indicates whether the API key can be used by clients.
- `generate_distinct_id` (Boolean) Specifies whether 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, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
- `stage_keys` (Attributes List) A list of stages to associate with this API key. (see [below for nested schema](#nestedatt--stage_keys))
- `tags` (Attributes List) An array of arbitrary tags (key-value pairs) to associate with the API key. (see [below for nested schema](#nestedatt--tags))
- `value` (String) The value of the API key. Must be at least 20 characters long.

### Read-Only

- `api_key_id` (String) A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- `id` (String) Uniquely identifies the resource.

<a id="nestedatt--stage_keys"></a>
### Nested Schema for `stage_keys`

Optional:

- `rest_api_id` (String) The ID of a RestApi resource that includes the stage with which you want to associate the API key.
- `stage_name` (String) The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.


<a id="nestedatt--tags"></a>
### Nested Schema for `tags`

Optional:

- `key` (String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- `value` (String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

## Import

Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_api_key.example <resource ID>
```