Resource: awsApiGatewayApiKey
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
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.apiGatewayApiKey.ApiGatewayApiKey(this, "MyDemoApiKey", {
name: "demo",
});
Argument Reference
The following arguments are supported:
name
- (Required) Name of the API keydescription
- (Optional) API key description. Defaults to "Managed by Terraform".enabled
- (Optional) Whether the API key can be used by callers. Defaults totrue
.value
- (Optional) Value of the API key. If not specified, it will be automatically generated by AWS on creation.tags
- (Optional) Key-value map of resource tags. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
id
- ID of the API keycreatedDate
- Creation date of the API keylastUpdatedDate
- Last update date of the API keyvalue
- Value of the API keyarn
- ARNtagsAll
- Map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
API Gateway Keys can be imported using the id
, e.g.,