Class ObservabilityPipelineClientTls

Configuration for enabling TLS encryption between the pipeline component and external services.

Hierarchy

  • ObservabilityPipelineClientTls

Constructors

constructor

Properties

additionalProperties? caFile? crtFile keyFile? keyPassKey? serverName?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional caFile

caFile?: string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crtFile

crtFile: string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

Optional keyFile

keyFile?: string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

Optional keyPassKey

keyPassKey?: string

Name of the environment variable or secret that holds the passphrase for the private key file.

Optional serverName

serverName?: string

Server name to use for Server Name Indication (SNI) and to verify against the certificate presented by the remote host. Use this when the address you connect to doesn't match the certificate's Common Name or Subject Alternative Name.

Settings

Member Visibility

Theme

Generated using TypeDoc