Subscribe
    Behavior

    origin

    zaiveeBy No Comments6 Mins Read

    Property Manager Name: Origin Server

    Specify the hostname and settings used to contact the origin once the service begins. You can use your own origin, NetStorage, an Edge Load Balancing origin, or a SaaS dynamic origin.

    Options

    • originType (enum string): Choose whether your content is retrieved from your own server (CUSTOMER), your NetStorage account (NET_STORAGE), any available Edge Load Balancing origin (EDGE_LOAD_BALANCING_ORIGIN_GROUP), a set of applicationLoadBalancer origins (APPLICATION_LOAD_BALANCER), a SaaS dynamic origin (SAAS_DYNAMIC_ORIGIN) if SaaS acceleration is available on your contract, or MEDIA_SERVICE_LIVE. NetStorage is most appropriate for static content.
    • netStorage (object): If the originType is NET_STORAGE, this option specifies the details of the netstorage server. For example:
    "netStorage": {
"id" : "netstorage_id",
"name" : "Example Downloads",
"downloadDomainName" : "download.example.com",
"cpCode" : 12345
}
    • originId (string): With the originType set to EDGE_LOAD_BALANCING_ORIGIN_GROUP, identifies the Edge Load Balancing origin. This must correspond to an edgeLoadBalancingOrigin behavior’s id attribute within the same property.
    • hostname (string; allows variables): With the originType set to CUSTOMER, this specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.
    • secondHostnameEnabled (boolean): Available only for certain products. This specifies whether you want to use an additional origin server address.
    • secondHostname (string; allows variables): With secondHostnameEnabled on, this specifies the origin server’s hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
    • mslorigin (string): With originType set to MEDIA_SERVICE_LIVE, this specifies the media’s origin server.
    • saasType (enum string): With originType set to SAAS_DYNAMIC_ORIGIN, specifies the part of the request that identifies this SaaS dynamic origin, either PATH, COOKIE, QUERY_STRING, or HOSTNAME.
    • saasCnameEnabled (boolean): With saasType set to HOSTNAME, enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.
    • saasCnameLevel (number): With saasType set to HOSTNAME and saasCnameEnabled on, specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.
    • saasCookie (string): With the originType set to SAAS_DYNAMIC_ORIGIN and the saasType set to COOKIE, this specifies the name of the cookie that identifies this SaaS dynamic origin.
    • saasQueryString (string): With the originType set to SAAS_DYNAMIC_ORIGIN and the saasType set to QUERY_STRING, this specifies the name of the query parameter that identifies this SaaS dynamic origin.
    • saasRegex (string): With the originType set to SAAS_DYNAMIC_ORIGIN, this specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
    • saasReplace (string): Specifies replacement text for what saasRegex matches.
    • saasSuffix (string): With the originType set to SAAS_DYNAMIC_ORIGIN, specifies the static part of the SaaS dynamic origin.
    • forwardHostHeader (enum string): When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host header to pass to the origin:
      • REQUEST_HOST_HEADER passes the original request’s header.
      • ORIGIN_HOSTNAME passes the current origin’s HOSTNAME.
      • CUSTOM passes the value of customForwardHostHeader. Use this option if you want requests handled by different properties to converge on the same cached object.
    • customForwardHostHeader (string; allows variables): With forwardHostHeader set to CUSTOM, this specifies the name of the custom host header the edge server should pass to the origin.
    • cacheKeyHostname (enum string): With the originType set to CUSTOM, this specifies the hostname to use when forming a cache key. Specify ORIGIN_HOSTNAME if your origin server’s responses do not depend on the hostname, otherwise specify REQUEST_HOST_HEADER when using a virtual server.
    • ipVersion (enum string): With originType set to CUSTOMER or EDGE_LOAD_BALANCING_ORIGIN_GROUP, this specifies which IP version to use when getting content from the origin. Set to either IPV4, IPV6, or DUALSTACK for both versions.
    • useUniqueCacheKey (boolean): With cacheKeyHostname set to ORIGIN_HOSTNAME and a shared hostname such as provided by Amazon AWS, sets a unique cache key for your content.
    • compress (boolean): Enables gzip compression for non-NetStorage origins.
    • enableTrueClientIp (boolean): When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.
    • trueClientIpHeader (string): With enableTrueClientIp enabled, this specifies the name of the field that identifies the end client’s IP address, for example True-Client-IP.
    • trueClientIpClientSetting (boolean): With enableTrueClientIp on along with this option, if a client sets the True-Client-IP header, the edge server allows it and passes the value to the origin. Otherwise the edge server removes it and sets the value itself.
    • verificationMode (enum string): For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust, either PLATFORM_SETTINGS, THIRD_PARTY when your origin server references certain types of third-party hostname, or CUSTOM. The CUSTOM option only applies if the property is marked as secure. See Secure property requirements for guidance. Under some products, you may also need to enable the Secure Delivery – Customer Cert module. Contact your Akamai representative for details.
    • originSni (boolean): For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. Contact your Akamai representative for more information.
    • customValidCnValues (array of string values): With verificationMode set to CUSTOM, specifies values to look for in the origin certificate’s Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)
    • originCertsToHonor (enum string): With verificationMode set to CUSTOM, specifies whether to trust pinned origin server certificates (CUSTOM_CERTIFICATES), any certificate signed by an Akamai-managed authority set (STANDARD_CERTIFICATE_AUTHORITIES), or any certificate signed by a custom authority set you manage (CUSTOM_CERTIFICATE_AUTHORITIES). If set to COMBO, may rely on all three inputs.
    • standardCertificateAuthorities (object): With originCertsToHonor set to either STANDARD_CERTIFICATE_AUTHORITIES or COMBO, specifies an array of Akamai-managed certificate names. Currently, the only allowed value is akamai-permissive.
    • customCertificateAuthorities (object): With originCertsToHonor set to either CUSTOM_CERTIFICATE_AUTHORITIES or COMBO, specifies an array of certification objects. Contact your Akamai representative for details on this object’s requirements.
    • customCertificates (object): With originCertsToHonor set to either CUSTOM_CERTIFICATES or COMBO, specifies an array of certification objects. Contact your Akamai representative for details on this object’s requirements.
    • httpPort (number): Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.
    • httpsPort (number): Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.

     

    Related Posts

    Add A Comment

    Leave A Reply