- Property Manager name: Origin Characteristics
- Behavior version: The
v2024-05-31
rule format supports theoriginCharacteristics
behavior v1.7. - Rule format status: Deprecated, outdated rule format
- Access: Read/Write
- Allowed in includes: Yes
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 clientCharacteristics
and various product-specific behaviors whose names are prefixed contentCharacteristics.
Option | Type | Description | Requires | |
---|---|---|---|---|
authenticationMethod | 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 | |||
GCS_HMAC_AUTHENTICATION | Google Cloud Platform. If you're using this authentication method, any | |||
encodingVersion | enum | Specifies the version of the encryption algorithm, an integer from | authenticationMethod is SIGNATURE_HEADER_AUTHENTICATION | {"displayType":"enum","options":["1","2","3","4","5"],"tag":"select"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}} |
useCustomSignString | boolean | Specifies whether to customize your signed string. | authenticationMethod is SIGNATURE_HEADER_AUTHENTICATION | {"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}} |
customSignString | string array | Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each. | authenticationMethod is SIGNATURE_HEADER_AUTHENTICATION AND useCustomSignString 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 | ||||
secretKey | object array | Specifies the shared secret key. | authenticationMethod 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. | authenticationMethod 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. | authenticationMethod 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. | authenticationMethod is MSL_AUTHENTICATION | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"MSL_AUTHENTICATION"}} |
accessKeyEncryptedStorage | 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. | authenticationMethod is either: AWS , GCS_HMAC_AUTHENTICATION | {"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"authenticationMethod","op":"in","value":["AWS","GCS_HMAC_AUTHENTICATION"]}} |
gcsAccessKeyVersionGuid | string | Identifies the unique | authenticationMethod is GCS_HMAC_AUTHENTICATION AND accessKeyEncryptedStorage 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}]}} |
gcsHmacKeyAccessId | string | Specifies the active access ID linked to your Google account. | authenticationMethod is GCS_HMAC_AUTHENTICATION AND accessKeyEncryptedStorage 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}]}} |
gcsHmacKeySecret | string | Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage. | authenticationMethod is GCS_HMAC_AUTHENTICATION AND accessKeyEncryptedStorage 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}]}} |
awsAccessKeyVersionGuid | string | Identifies the unique | authenticationMethod is AWS AND accessKeyEncryptedStorage is true | {"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"AWS"},{"attribute":"accessKeyEncryptedStorage","op":"eq","value":true}]}} |
awsAccessKeyId | string | Specifies active access key ID linked to your AWS account. | authenticationMethod is AWS AND accessKeyEncryptedStorage 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}]}} |
awsSecretAccessKey | string | Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS. | authenticationMethod is AWS AND accessKeyEncryptedStorage 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}]}} |
awsRegion | string | This specifies the AWS region code of the location where your bucket resides. | authenticationMethod is AWS | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}} |
awsHost | string | This specifies the AWS hostname, without | authenticationMethod is AWS | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}} |
awsService | string | This specifies the subdomain of your AWS service. It precedes | authenticationMethod 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. | |||
directConnectGeo | 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"}} |