originCharacteristics


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 content‚ÄčCharacteristics.

OptionTypeDescriptionRequires
authentication‚ÄčMethodenum

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.

GCS_‚ÄčHMAC_‚ÄčAUTHENTICATION

Google Cloud Platform.

AWS_‚ÄčSTS

Amazon Web Services (AWS) Security Token Service you use to request temporary security credentials for your AWS resources.

encoding‚ÄčVersionenum

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‚ÄčStringboolean

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‚ÄčStringstring 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‚ÄčKeyobject 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"}}
noncestring

Specifies the nonce.

authentication‚ÄčMethod is SIGNATURE_‚ÄčHEADER_‚ÄčAUTHENTICATION
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
mslkeystring

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"}}
mslnamestring

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‚ÄčStorageboolean

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‚ÄčGuidstring

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‚ÄčIdstring

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‚ÄčSecretstring

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‚ÄčGuidstring

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‚ÄčIdstring

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‚ÄčKeystring

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‚ÄčRegionstring

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‚ÄčHoststring

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‚ÄčServicestring

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"}}
property‚ÄčId‚ÄčTagboolean

Whether to include the property identifier for this delivery configuration as an additional identifier tag in the Assume Role verification call to AWS. You'll need to include the property identifier (AK_‚ÄčARLID) in a condition in your AWS IAM policy for validation.

authentication‚ÄčMethod is AWS_‚ÄčSTS
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS_STS"}}
hostname‚ÄčTagboolean

Whether to include the hostname used to access this delivery configuration as an additional identifier tag in the Assume Role verification call to AWS. You'll need to include this hostname (AK_‚ÄčHOST) in a condition in your AWS IAM policy for validation.

authentication‚ÄčMethod is AWS_‚ÄčSTS
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS_STS"}}
role‚ÄčArnstring

The Amazon Resource Name (ARN) of the AWS IAM role you want to use. This role needs to be configured with the proper permissions for your target resources. The AWS IAM policy needs to contain the trust relationships defining other users that can assume this role.

authentication‚ÄčMethod is AWS_‚ÄčSTS
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS_STS"}}
aws‚ÄčAr‚ÄčRegionstring

Specifies the AWS region code that represents the location of your AWS bucket.

authentication‚ÄčMethod is AWS_‚ÄčSTS
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS_STS"}}
end‚ÄčPoint‚ÄčServicestring

Specifies the code of your AWS service. It precedes .amazonaws.‚Äčcom or the region code in your AWS hostname.

authentication‚ÄčMethod is AWS_‚ÄčSTS
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS_STS"}}
countryenum

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‚ÄčGeostring

Provides a region used by Akamai Direct Connection.

country is ADC
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"country","op":"eq","value":"ADC"}}