Skip to content

Data Source: awsApiGatewayApiKey

Use this data source to get the name and value of a pre-existing API Key, for example to supply credentials for a dependency microservice.

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.dataAwsApiGatewayApiKey.DataAwsApiGatewayApiKey(this, "my_api_key", {
  id: "ru3mpjgse6",
});

Argument Reference

  • id - (Required) ID of the API Key to look up.

Attributes Reference

  • id - Set to the ID of the API Key.
  • name - Set to the name of the API Key.
  • value - Set to the value of the API Key.
  • createdDate - Date and time when the API Key was created.
  • lastUpdatedDate - Date and time when the API Key was last updated.
  • description - Description of the API Key.
  • enabled - Whether the API Key is enabled.
  • tags - Map of tags for the resource.