GuideReference
TrainingSupportCommunity
Guide

Client lists

akamai_clientlist_lists

🚧

Beta

While the underlying code for our Client Lists subprovider has been vetted, we’ve placed the beta label here only to collect your feedback and work through any issues.

Get a details for all of your client lists or use filters to narrow the results to a particular list name, list type, or output option.

data "akamai_clientlist_lists" "my_clientlists" {
}

output "my_clientlists" {
  value = data.akamai_clientlist_lists.my_clientlists
}
Changes to Outputs:
+ my_clientlists = {
    + id          = "c113n7l157a1bce2345f67ghi8ak9lm01n23456"
    + json        = jsonencode(
          [
            + {
                + Items                      = null
                + createDate                 = "2023-08-14T13:54:20.870+00:00"
                + createdBy                  = "jsmith"
                + deprecated                 = false
                + itemsCount                 = 1
                + listId                     = "123456_MYLISTID"
                + listType                   = "CL"
                + name                       = "my_list_name"
                + notes                      = ""
                + productionActivationStatus = "ACTIVE"
                + productionActiveVersion    = 1
                + readOnly                   = false
                + shared                     = false
                + stagingActivationStatus    = "INACTIVE"
                + stagingActiveVersion       = 0
                + tags                       = []
                + type                       = "IP"
                + updateDate                 = "2023-08-14T13:54:20.870+00:00"
                + updatedBy                  = "jsmith"
                + version                    = 1
              },
          ]
      )
    + list_ids    = [
        + "123456_MYLISTID",
      ]
    + lists       = [
        + {
            + create_date                  = "2023-08-14T13:54:20.870+00:00"
            + created_by                   = "jsmith"
            + deprecated                   = false
            + items_count                  = 1
            + list_id                      = "123456_MYLISTID"
            + list_type                    = "CL"
            + name                         = "my_list_name"
            + notes                        = ""
            + production_activation_status = "ACTIVE"
            + read_only                    = false
            + shared                       = false
            + staging_activation_status    = "INACTIVE"
            + tags                         = []
            + type                         = "IP"
            + update_date                  = "2023-08-14T13:54:20.870+00:00"
            + updated_by                   = "jsmith"
            + version                      = 1
          },
      ]
    + name        = null
    + output_text = <<-EOT
          +--------------------------------------------------------------------------------------------------------------------------+
          | clientListsDS |
          +------------------+---------------+------+------+------------+---------+----------+-------------------------------+-------+
          | LISTID           | NAME          | TAGS | TYPE | ITEMSCOUNT | VERSION | READONLY | UPDATEDATE                    | NOTES |
          +------------------+---------------+------+------+------------+---------+----------+-------------------------------+-------+
          | 123456_MYLISTID  | my_list_name  | []   | IP   | 1          | 1       | false    | 2023-08-14T13:54:20.870+00:00 |       |
      EOT
    + type        = null
  }
variable "list_id" {
  type        = string
  description = "My list name"
  default     = "123456_MYLISTID"
}
// tvars
list_id = var.list_id

Arguments

If you pass this data source empty, config_section argument in the Akamai provider block of your Terraform configuration provides the necessary information.

Pass one or both of the filters to reduce the returned list.

ArgumentRequiredDescription
nameA client list's name.
typeA client list's type.
  • GEO
  • ASN
  • TLSFingerprint
  • FileHash

Attributes

Returned to you is a set of your client lists based on what you passed in the data block body.

AttributeDescription
nameA client list's name.
typeA client list's type.
notesComments or other human-readable details about your client list.
tagsUser-created identifiers to filter client list searches.
list_idA set of client list IDs.
versionA client list's version.
items_countThe number of items a client list contains.
create_dateThe ISO 8601 time stamp for the client list's creation.
created_byThe name of the user who created the client list.
update_dateThe ISO 8601 time stamp for a client list's latest update.
updated_byThe name of the user who last updated the client list.
production_activation_statusThe activation status on the production network.
staging_activation_statusThe activation status on the staging network.
list_typeA client list's type.
  • GEO
  • ASN
  • TLSFingerprint
  • FileHash
sharedA client list made by Akamai that's shared across customers.
read_onlyWhether the client list is editable for the authenticated user.
deprecatedWhether the client list was removed.