origin_​characteristics

Version: v2025-01-13Includes use: Yes

Behavior name: Origin Characteristics

Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.

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" "origin_characteristics" {
  rules_v2025_02_18 {
    name     = "Origin Characteristics"
    comments = "Specifies characteristics of the origin."
    behavior {
      origin_characteristics {
        authentication_method = "AUTOMATIC"
        country               = "UNKNOWN"
      }
    }
  }
}
"behaviors": [
  {
    "name": "originCharacteristics",
    "options": {
      "authenticationMethod": "AUTOMATIC",
      "country": "UNKNOWN"
      }
  }
]

Options

Option Description
authentication_method
Specifies the authentication method. Value is one of:
  • AUTOMATIC. Use default authentication.
  • SIGNATURE_HEADER_AUTHENTICATION. Available with the Adaptive Media Delivery, Object Delivery, Download Delivery, API Acceleration, Dynamic Site Acceleration, and Ion products.
  • MSL_AUTHENTICATION. Available with the Adaptive Media Delivery product.
  • AWS. Amazon Web Services. If you're using this authentication method, any chase_redirects behavior you specify gets automatically disabled.
  • GCS_HMAC_AUTHENTICATION. Google Cloud Platform. If you're using this authentication method, any chase_redirects behavior you specify gets automatically disabled.
encoding_version
Specifies the version of the encryption algorithm, an integer from 1 to 5.
use_custom_sign_string
Specifies whether to customize your signed string.
custom_sign_string
Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each. Value is one of:
  • AK_CLIENT_REAL_IP
  • AK_DOMAIN
  • AK_EXTENSION
  • AK_FILENAME
  • AK_HOSTHEADER
  • AK_METHOD
  • AK_PATH
  • AK_QUERY
  • AK_SCHEME
  • AK_URL
secret_key
Specifies the shared secret key.
nonce
Specifies the nonce.
mslkey
Specifies the access key provided by the hosting service.
mslname
Specifies the origin name provided by the hosting service.
access_key_encrypted_storage
gcs_access_key_version_guid
Identifies the unique gcs_access_key_version_guid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.
gcs_hmac_key_access_id
Specifies the active access ID linked to your Google account.
gcs_hmac_key_secret
Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
aws_access_key_version_guid
Identifies the unique aws_access_key_version_guid access key created in Cloud Access Manager to sign your requests to AWS S3.
aws_access_key_id
Specifies active access key ID linked to your AWS account.
aws_secret_access_key
Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
aws_region
This specifies the AWS region code of the location where your bucket resides.
aws_host
This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.
aws_service
This specifies the subdomain of your AWS service. It precedes amazonaws.com or the region code in the AWS hostname. For example, s3.amazonaws.com.
sort_query_params
Sorts the query string parameters alphabetically by key name.
encode_query_params
Encodes the query string parameters.
encode_equals
Encodes any equal (=) characters in a query parameter's value.
country
Specifies the origin's geographic region. Value is one of:
  • EUROPE
  • NORTH_AMERICA
  • LATIN_AMERICA
  • SOUTH_AMERICA
  • NORDICS
  • ASIA_PACIFIC
  • AUSTRALIA
  • GERMANY
  • INDIA
  • ITALY
  • JAPAN
  • MEXICO
  • TAIWAN
  • UNITED_KINGDOM
  • US_EAST
  • US_CENTRAL
  • US_WEST

Global and other locations:
  • GLOBAL_MULTI_GEO. Global.
  • OTHER_APJ. Asia, Pacific, Japan.
  • OTHER_EMEA. Europe, Middle East, Africa.
  • OTHER_AMERICAS. Other Americas.
  • OTHER. A fallback value.
  • UNKNOWN. Defer this optimization.
  • ADC. Akamai Direct Connection, available to Adaptive Media Delivery customers.
direct_connect_geo
Provides a region used by Akamai Direct Connection.