Interface BackendConfiguration

Hierarchy

  • BackendConfiguration

Properties

betweenBytesTimeout? caCertificate? certificateHostname? ciphers? connectTimeout? firstByteTimeout? hostOverride? name sniHostname? target tlsMaxVersion? tlsMinVersion? useSSL?

Properties

Optional betweenBytesTimeout

betweenBytesTimeout?: number

Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end.

Default Value

10_000

Throws

Throws a RangeError if the value is negative or greater than or equal to 2^32

Optional caCertificate

caCertificate?: string

The CA certificate to use when checking the validity of the backend.

Throws

Throws a TypeError if the value is an empty string.

Optional certificateHostname

certificateHostname?: string

Define the hostname that the server certificate should declare.

Throws

Throws a TypeError if the value is an empty string.

Optional ciphers

ciphers?: string

List of OpenSSL ciphers to support for connections to this origin. If the backend server is not able to negotiate a connection meeting this constraint, a 503 response will be presented instead.

List of ciphers supported by Fastly.

Throws

Throws a TypeError if the value is an empty string.

Optional connectTimeout

connectTimeout?: number

Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a 503 response will be presented instead.

Default Value

1_000

Throws

Throws a RangeError if the value is negative or greater than or equal to 2^32

Optional firstByteTimeout

firstByteTimeout?: number

Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a 503 response will be presented instead.

Default Value

15_000

Throws

Throws a RangeError if the value is negative or greater than or equal to 2^32

Optional hostOverride

hostOverride?: string

If set, will force the HTTP Host header on connections to this backend to be the supplied value.

Example

"example.com:443"

Throws

Throws a TypeError if the value is an empty string.

name

name: string

The name of the backend. The name has to be between 1 and 254 characters inclusive. The name can be whatever you would like, as long as it does not match the name of any of the static service backends nor match any other dynamic backends built during a single execution of the application.

Throws

Throws a TypeError if the value is not valid. I.E. The value is null, undefined, an empty string or a string with more than 254 characters.

Optional sniHostname

sniHostname?: string

The SNI hostname to use on connections to this backend.

Throws

Throws a TypeError if the value is an empty string.

target

target: string

A hostname, IPv4, or IPv6 address for the backend as well as an optional port. If set, the target has to be at-least 1 character.

Example

hostname
"example.com"

Example

hostname and port
"example.com:443"

Example

ip address
"1.2.3.4"

Example

ip address and port
"1.2.3.4:8080"

Throws

Throws a TypeError if the value is not valid. I.E. Is null, undefined, an empty string, not a valid IP address or host, or is the string ::

Optional tlsMaxVersion

tlsMaxVersion?: 1 | 1.1 | 1.2 | 1.3

Maximum allowed TLS version on SSL connections to this backend. If the backend server is not able to negotiate a connection meeting this constraint, a 503 response will be presented instead.

Throws

Throws a RangeError if the value is not 1, 1.1, 1.2, or 1.3

Optional tlsMinVersion

tlsMinVersion?: 1 | 1.1 | 1.2 | 1.3

Minimum allowed TLS version on SSL connections to this backend. If the backend server is not able to negotiate a connection meeting this constraint, a 503 response will be presented instead.

Throws

Throws a RangeError if the value is not 1, 1.1, 1.2, or 1.3

Optional useSSL

useSSL?: boolean

Whether or not to require TLS for connections to this backend.

Settings

Member Visibility

Theme

Generated using TypeDoc