Rules

akamai_property_rules

Retrieve a rule tree of an existing property version for contracts and groups you have access to.

data "akamai_property_rules" "my_property_rules" {
    property_id = "12345"
    version     = 2
    group_id    = "123456"
    contract_id = "C-0N7RAC7"
}

output "my_property_rules" {
  value = data.akamai_property_rules.my_property_rules
}
my_property_rules = {
      contract_id = "ctr_C-0N7RAC7"
      errors      = null
      group_id    = "grp_123456"
      id          = "12345"
      property_id = "prp_12345"
      rule_format = "v2024-05-31"
      rules       = jsonencode(
            {
              rules = {
                  behaviors = [
                      {
                          name    = "origin"
                          options = {
                              cacheKeyHostname          = "ORIGIN_HOSTNAME"
                              compress                  = true
                              enableTrueClientIp        = true
                              forwardHostHeader         = "REQUEST_HOST_HEADER"
                              hostname                  = "example.com"
                              httpPort                  = 80
                              httpsPort                 = 443
                              ipVersion                 = "IPV4"
                              minTlsVersion             = "DYNAMIC"
                              originCertificate         = ""
                              originSni                 = true
                              originType                = "CUSTOMER"
                              ports                     = ""
                              tlsVersionTitle           = ""
                              trueClientIpClientSetting = false
                              trueClientIpHeader        = "True-Client-IP"
                              verificationMode          = "PLATFORM_SETTINGS"
                            }
                        },
                      {
                          name    = "originCharacteristics"
                          options = {
                              accessKeyEncryptedStorage = true
                              authenticationMethod      = "GCS_HMAC_AUTHENTICATION"
                              authenticationMethodTitle = ""
                              country                   = "NORTH_AMERICA"
                              gcsAccessKeyVersionGuid   = "12abcd3ef-45gh-678i-j9k12345l6m7"
                              originLocationTitle       = ""
                            }
                        },
                      {
                          name    = "contentCharacteristics"
                          options = {
                              catalogSize            = "MEDIUM"
                              contentType            = "USER_GENERATED"
                              objectSize             = "LESS_THAN_1MB"
                              popularityDistribution = "LONG_TAIL"
                            }
                        },
                      {
                          name    = "clientCharacteristics"
                          options = {
                              country = "NORTH_AMERICA"
                            }
                        },
                      {
                          name    = "restrictObjectCaching"
                          options = {
                              maximumSize = ""
                            }
                        },
                      {
                          name    = "cpCode"
                          options = {
                              value = {
                                  createdDate = 1708523914000
                                  description = "My CP code"
                                  id          = 12345
                                  name        = "My CP code"
                                  products    = [
                                      "Obj_Delivery",
                                    ]
                                }
                            }
                        },
                      {
                          name    = "dynamicThroughtputOptimization"
                          options = {
                              enabled = true
                            }
                        },
                      {
                          name    = "http2"
                          options = {
                              enable = false
                            }
                        },
                      {
                          name    = "autoDomainValidation"
                          options = {
                              autodv = ""
                            }
                        },
                      {
                          name    = "include"
                          options = {
                              id = "123456"
                            }
                        },
                    ]
                  name      = "default"
                  options   = {}
                }
            }
        )
      version     = 2
    }

Arguments

Send your property ID in the body of the declaration to get a property version's rule tree.

ArgumentRequiredDescription
property_id✔️Your property's ID.
versionYour property's version number. If no value is passed, the information returned is from the latest version.
contract_idYour contract ID.
group_idYour group ID.

Attributes

Returned to you is a computed set of the given property version's rule tree.

AttributeDescription
contract_idYour contract ID.
errorsA list of validation errors for the rule-tree object returned.
group_idYour group ID.
idYour property's ID.
property_idYour property's ID.
rule_formatThe rule tree version used.
rulesA JSON-encoded rule tree for the property version.
versionYour property's version number.