Client lists

akamai_clientlist_lists

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.

Argument	Required	Description
`name`		A client list's name.
`type`		A client list's type. `IP` `GEO` `ASN` `TLS_FINGERPRINT` `FILE_HASH`

Attributes

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

List

Attribute	Description
`json`	A JSON encoded representation of your client lists details. See the JSON table for its attributes.
`list_ids`	A set of your client list IDs.
`lists`	A set of details about each of your client lists. See the Lists table for its attributes.
`name`	The name of your client list.
`output_text`	A table representation of your client lists details. See the Output text table for its attributes.

JSON

Attribute	Description
`createDate`	The ISO 8601 time stamp for the client list's creation.
`createdBy`	The name of the user who created the client list.
`deprecated`	Whether the client list was removed.
`itemsCount`	The number of items a client list contains.
`listId`	The client list's ID.
`listType`	A client list's type. `IP` `GEO` `ASN` `TLSFingerprint` `FileHash`
`name`	A client list's name.
`notes`	Comments or other human-readable details about your client list.
`productionActivationStatus`	The client list's activation status on the production network.
`productionActiveVersion`	The version number of the client list active on the production network.
`readOnly`	Whether the client list is editable for the authenticated user.
`shared`	A client list made by Akamai that's shared across customers.
`stagingActivationStatus`	The client list's activation status on the staging network.
`productionActiveVersion`	The version number of the client list active on the staging network.
`tags`	User-created identifiers to filter client list searches.
`type`	A client list's type.
`updateDate`	The ISO 8601 time stamp for a client list's latest update.
`updatedBy`	The name of the user who last updated the client list.
`version`	A client list's version.

Lists

Attribute	Description
`create_date`	The ISO 8601 time stamp for the client list's creation.
`created_by`	The name of the user who created the client list.
`deprecated`	Whether the client list was removed.
`items_count`	The number of items a client list contains.
`list_id`	The client list's ID.
`list_type`	A client list's type. `GEO` `ASN` `TLSFingerprint` `FileHash`
`name`	A client list's name.
`notes`	Comments or other human-readable details about your client list.
`production_activation_status`	The activation status on the production network.
`read_only`	Whether the client list is editable for the authenticated user.
`shared`	A client list made by Akamai that's shared across customers.
`staging_activation_status`	The activation status on the staging network.
`tags`	User-created identifiers to filter client list searches.
`type`	A client list's type.
`update_date`	The ISO 8601 time stamp for a client list's latest update.
`updated_by`	The name of the user who last updated the client list.
`version`	A client list's version.

Output text

Attribute	Description
`ITEMSCOUNT`	The number of items a client list contains.
`LISTID`	The client list's ID.
`NAME`	A client list's name.
`NOTES`	Comments or other human-readable details about your client list.
`READONLY`	Whether the client list is editable for the authenticated user.
`TAGS`	User-created identifiers to filter client list searches.
`TYPE`	A client list's type.
`UPDATEDATE`	The ISO 8601 time stamp for a client list's latest update.
`VERSION`	A client list's version.

Updated 3 months ago