origin_characteristics

Property Manager name: Origin Characteristics
Behavior version: The v2024-01-09 rule format supports the origin_characteristics behavior v1.7.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

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.

See also client_characteristics and various product-specific behaviors whose names are prefixed contentCharacteristics.

Option	Type	Description	Requires
`authentication_method`	enum	Specifies the authentication method.		{"displayType":"enum","options":["AUTOMATIC","SIGNATURE_HEADER_AUTHENTICATION","MSL_AUTHENTICATION","AWS","GCS_HMAC_AUTHENTICATION","AWS_STS"],"tag":"select"}
	`AUTOMATIC`	Use default authentiation.
	`SIGNATURE_HEADER_AUTHENTICATION`	Available with the Adaptive Media Delivery product.
	`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`	enum	Specifies the version of the encryption algorithm, an integer from `1` to `5`.	`authentication_method` is `SIGNATURE_HEADER_AUTHENTICATION`	{"displayType":"enum","options":["1","2","3","4","5"],"tag":"select"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
`use_custom_sign_string`	boolean	Specifies whether to customize your signed string.	`authentication_method` is `SIGNATURE_HEADER_AUTHENTICATION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
`custom_sign_string`	string array	Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.	`authentication_method` is `SIGNATURE_HEADER_AUTHENTICATION` AND `use_custom_sign_string` is `true`	{"displayType":"string array","options":["AK_METHOD","AK_SCHEME","AK_HOSTHEADER","AK_DOMAIN","AK_URL","AK_PATH","AK_QUERY","AK_FILENAME","AK_EXTENSION","AK_CLIENT_REAL_IP"],"tag":"select"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"},{"attribute":"useCustomSignString","op":"eq","value":true}]}}
		Supported values: AK_CLIENT_REAL_IP AK_DOMAIN AK_EXTENSION AK_FILENAME AK_HOSTHEADER AK_METHOD AK_PATH AK_QUERY AK_SCHEME AK_URL
`secret_key`	object array	Specifies the shared secret key.	`authentication_method` is `SIGNATURE_HEADER_AUTHENTICATION`	{"displayType":"object array","tag":"input","todo":true} {"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
`nonce`	string	Specifies the nonce.	`authentication_method` is `SIGNATURE_HEADER_AUTHENTICATION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
`mslkey`	string	Specifies the access key provided by the hosting service.	`authentication_method` is `MSL_AUTHENTICATION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"MSL_AUTHENTICATION"}}
`mslname`	string	Specifies the origin name provided by the hosting service.	`authentication_method` is `MSL_AUTHENTICATION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"MSL_AUTHENTICATION"}}
`access_key_encrypted_storage`	boolean	Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.	`authentication_method` is either: `AWS`, `GCS_HMAC_AUTHENTICATION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"authenticationMethod","op":"in","value":["AWS","GCS_HMAC_AUTHENTICATION"]}}
`gcs_access_key_version_guid`	string	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.	`authentication_method` is `GCS_HMAC_AUTHENTICATION` AND `access_key_encrypted_storage` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"GCS_HMAC_AUTHENTICATION"},{"attribute":"accessKeyEncryptedStorage","op":"eq","value":true}]}}
`gcs_hmac_key_access_id`	string	Specifies the active access ID linked to your Google account.	`authentication_method` is `GCS_HMAC_AUTHENTICATION` AND `access_key_encrypted_storage` is not `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"GCS_HMAC_AUTHENTICATION"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
`gcs_hmac_key_secret`	string	Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.	`authentication_method` is `GCS_HMAC_AUTHENTICATION` AND `access_key_encrypted_storage` is not `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"GCS_HMAC_AUTHENTICATION"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
`aws_access_key_version_guid`	string	Identifies the unique `aws_access_key_version_guid` access key created in Cloud Access Manager to sign your requests to AWS S3.	`authentication_method` is `AWS` AND `access_key_encrypted_storage` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"AWS"},{"attribute":"accessKeyEncryptedStorage","op":"eq","value":true}]}}
`aws_access_key_id`	string	Specifies active access key ID linked to your AWS account.	`authentication_method` is `AWS` AND `access_key_encrypted_storage` is not `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"AWS"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
`aws_secret_access_key`	string	Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.	`authentication_method` is `AWS` AND `access_key_encrypted_storage` is not `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"AWS"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
`aws_region`	string	This specifies the AWS region code of the location where your bucket resides.	`authentication_method` is `AWS`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}}
`aws_host`	string	This specifies the AWS hostname, without `http://` or `https://` prefixes. If you leave this option empty, it inherits the hostname from the `origin` behavior.	`authentication_method` is `AWS`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}}
`aws_service`	string	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`.	`authentication_method` is `AWS`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}}
`country`	enum	Specifies the origin's geographic region.		{"displayType":"enum","options":["EUROPE","NORTH_AMERICA","LATIN_AMERICA","SOUTH_AMERICA","NORDICS","ASIA_PACIFIC","OTHER_AMERICAS","OTHER_APJ","OTHER_EMEA","AUSTRALIA","GERMANY","INDIA","ITALY","JAPAN","MEXICO","TAIWAN","UNITED_KINGDOM","US_EAST","US_CENTRAL","US_WEST","GLOBAL_MULTI_GEO","OTHER","UNKNOWN","ADC"],"tag":"select"}
	`EUROPE`	Europe.
	`NORTH_AMERICA`	North America.
	`LATIN_AMERICA`	Latin America.
	`SOUTH_AMERICA`	South America.
	`NORDICS`	Northern Europe.
	`ASIA_PACIFIC`	Asia and Pacific Islands.
	`OTHER_AMERICAS`	Other Americas.
	`OTHER_APJ`	Asia, Pacific, Japan.
	`OTHER_EMEA`	Europe, Middle East, Africa.
	`AUSTRALIA`	Australia.
	`GERMANY`	Germany.
	`INDIA`	India.
	`ITALY`	Italy.
	`JAPAN`	Japan.
	`MEXICO`	Mexico.
	`TAIWAN`	Taiwan.
	`UNITED_KINGDOM`	United Kingdom.
	`US_EAST`	Eastern United States.
	`US_CENTRAL`	Central United States.
	`US_WEST`	Western United States.
	`GLOBAL_MULTI_GEO`	Global.
	`OTHER`	A fallback value.
	`UNKNOWN`	Defer this optimization.
	`ADC`	Akamai Direct Connection, available to Adaptive Media Delivery customers.
`direct_connect_geo`	string	Provides a region used by Akamai Direct Connection.	`country` is `ADC`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"country","op":"eq","value":"ADC"}}