ecms_​database

Version: v2025-01-13Includes use: No

Behavior name: Message Store database selection

Edge Connect Message Store is available for Internet of Things: Edge Connect users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB. ecmsDatabase specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure the ecms_dataset behavior to specify a default data set for requests.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "ecms_database" {
  rules_v2025_02_18 {
    name     = "Message Store database selection"
    comments = "Create databases and data sets within these databases."
    behavior {
      ecms_database {
        database         = ""
        extract_location = "CLIENT_REQUEST_HEADER"
        header_name      = "X-KV-Database"
      }
    }
  }
}
"behaviors": [
  {
    "name": "ecmsDatabase",
    "options": {
      "database": "",
      "extractLocation": "CLIENT_REQUEST_HEADER",
      "headername": "X-KV-Database"
      }
  }
]

Options

Option Description
database
Specifies a default database for this property. If you don't configure a default data set in the ecms_dataset behavior, requests to objects in this database follow the pattern: <hostname>/datastore/<data_set_name>/<object_key>.
extract_location
Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used. Value is one of:
  • CLIENT_REQUEST_HEADER. Name is a request header.
  • QUERY_STRING. Name is a query parameter.
  • REGEX. Name matches the URL.
header_name
Specifies the request header that passed the database name. By default, it points to X-KV-Database.
query_parameter_name
Specifies the query string parameter that passed the database name. By default, it points to database.
regex_pattern
Specifies the regular expression that matches the database name in the URL.