Skip to content

Interface: ConnectionOptions

Defined in: glide-mq/src/types.ts:28

Properties

addresses

ts
addresses: object[];

Defined in: glide-mq/src/types.ts:29

host

ts
host: string;

port

ts
port: number;

clientAz?

ts
optional clientAz?: string;

Defined in: glide-mq/src/types.ts:48

Availability zone of the client (e.g., 'us-east-1a'). Used with readFrom 'AZAffinity' or 'AZAffinityReplicasAndPrimary' to route read commands to nodes in the same AZ, reducing cross-AZ latency and cost.


clusterMode?

ts
optional clusterMode?: boolean;

Defined in: glide-mq/src/types.ts:32


credentials?

ts
optional credentials?: 
  | PasswordCredentials
  | IamCredentials;

Defined in: glide-mq/src/types.ts:31


inflightRequestsLimit?

ts
optional inflightRequestsLimit?: number;

Defined in: glide-mq/src/types.ts:53

Maximum concurrent in-flight requests per client connection. Passed through to GLIDE. Default: 1000.


readFrom?

ts
optional readFrom?: ReadFrom;

Defined in: glide-mq/src/types.ts:42

Read strategy for the client. Controls how read commands are routed.

  • 'primary': Always read from primary (default).
  • 'preferReplica': Round-robin across replicas, fallback to primary.
  • 'AZAffinity': Route reads to replicas in the same availability zone.
  • 'AZAffinityReplicasAndPrimary': Route reads to any node in the same AZ.

AZ-based strategies require clientAz to be set.


useTLS?

ts
optional useTLS?: boolean;

Defined in: glide-mq/src/types.ts:30

Released under the Apache-2.0 License.