» Resource: aws_api_gateway_api_key
Provides an API Gateway API Key.
NOTE: Since the API Gateway usage plans feature was launched on August 11, 2016, usage plans are now required to associate an API key with an API stage.
» Example Usage
resource "aws_api_gateway_api_key" "MyDemoApiKey" {
name = "demo"
}
» Argument Reference
The following arguments are supported:
-
name
- (Required) The name of the API key -
description
- (Optional) The API key description. Defaults to "Managed by Terraform". -
enabled
- (Optional) Specifies whether the API key can be used by callers. Defaults totrue
. -
value
- (Optional) The value of the API key. If not specified, it will be automatically generated by AWS on creation.
» Attribute Reference
In addition to all arguments above, the following attributes are exported:
-
id
- The ID of the API key -
created_date
- The creation date of the API key -
last_updated_date
- The last update date of the API key -
value
- The value of the API key
» Import
API Gateway Keys can be imported using the id
, e.g.
$ terraform import aws_api_gateway_api_key.my_demo_key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk