» Resource: aws_api_gateway_api_key

Provides an API Gateway API Key.

» 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 to true.
  • value - (Optional) The value of the API key. If not specified, it will be automatically generated by AWS on creation.
  • tags - (Optional) Key-value mapping of resource tags

» 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
  • arn - Amazon Resource Name (ARN)

» Import

API Gateway Keys can be imported using the id, e.g.

$ terraform import aws_api_gateway_api_key.my_demo_key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk