Type Alias PostNodeBalancerData

Type Declaration

• Optionalclient_conn_throttle?: number

  Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to 0 (zero) to disable throttling.

• Optionalconfigs?: (
      | {
          algorithm?: "roundrobin"
          | "leastconn"
          | "ring_hash";
          check?: "none" | "connection" | "http" | "http_body";
          check_attempts?: number;
          check_body?: string;
          check_interval?: number;
          check_passive?: boolean;
          check_path?: string;
          check_timeout?: number;
          cipher_suite?: string;
          id?: number;
          nodebalancer_id?: number;
          nodes: {
              address?: string;
              config_id?: number;
              id?: number;
              label?: string;
              mode?: "none";
              nodebalancer_id?: number;
              status?: "unknown" | "UP" | "DOWN";
              subnet_id?: number;
              weight?: number;
          }[];
          nodes_status?: { down?: number; up?: number };
          port?: number;
          protocol?: "udp";
          proxy_protocol?: string;
          ssl_cert?: string | null;
          ssl_commonname?: string;
          ssl_fingerprint?: string;
          ssl_key?: string | null;
          stickiness?: "none" | "session" | "source_ip";
          udp_check_port?: number;
          udp_session_timeout?: number;
      }
      | {
          algorithm?: "roundrobin"
          | "leastconn"
          | "source";
          check?: "none" | "connection" | "http" | "http_body";
          check_attempts?: number;
          check_body?: string;
          check_interval?: number;
          check_passive?: boolean;
          check_path?: string;
          check_timeout?: number;
          cipher_suite?: string;
          id?: number;
          nodebalancer_id?: number;
          nodes: {
              address?: string;
              config_id?: number;
              id?: number;
              label?: string;
              mode?: "accept" | "reject" | "drain" | "backup";
              nodebalancer_id?: number;
              status?: "unknown" | "UP" | "DOWN";
              subnet_id?: number;
              weight?: number;
          }[];
          nodes_status?: { down?: number; up?: number };
          port?: number;
          protocol?: "tcp";
          proxy_protocol?: "none" | "v1" | "v2";
          ssl_cert?: string | null;
          ssl_commonname?: string;
          ssl_fingerprint?: string;
          ssl_key?: string | null;
          stickiness?: "none" | "table";
      }
      | {
          algorithm?: "roundrobin"
          | "leastconn"
          | "source";
          check?: "none" | "connection" | "http" | "http_body";
          check_attempts?: number;
          check_body?: string;
          check_interval?: number;
          check_passive?: boolean;
          check_path?: string;
          check_timeout?: number;
          cipher_suite?: string;
          id?: number;
          nodebalancer_id?: number;
          nodes: {
              address?: string;
              config_id?: number;
              id?: number;
              label?: string;
              mode?: "accept" | "reject" | "drain" | "backup";
              nodebalancer_id?: number;
              status?: "unknown" | "UP" | "DOWN";
              subnet_id?: number;
              weight?: number;
          }[];
          nodes_status?: { down?: number; up?: number };
          port?: number;
          protocol?: "http";
          proxy_protocol?: string;
          ssl_cert?: string | null;
          ssl_commonname?: string;
          ssl_fingerprint?: string;
          ssl_key?: string | null;
          stickiness?: "none" | "table" | "http_cookie";
      }
      | {
          algorithm?: "roundrobin"
          | "leastconn"
          | "source";
          check?: "none" | "connection" | "http" | "http_body";
          check_attempts?: number;
          check_body?: string;
          check_interval?: number;
          check_passive?: boolean;
          check_path?: string;
          check_timeout?: number;
          cipher_suite?: "recommended" | "legacy";
          id?: number;
          nodebalancer_id?: number;
          nodes: {
              address?: string;
              config_id?: number;
              id?: number;
              label?: string;
              mode?: "accept" | "reject" | "drain" | "backup";
              nodebalancer_id?: number;
              status?: "unknown" | "UP" | "DOWN";
              subnet_id?: number;
              weight?: number;
          }[];
          nodes_status?: { down?: number; up?: number };
          port?: number;
          protocol?: "https";
          proxy_protocol?: string;
          ssl_cert?: string | null;
          ssl_commonname?: string;
          ssl_fingerprint?: string;
          ssl_key?: string | null;
          stickiness?: "none" | "table" | "http_cookie";
      }
  )[]

  The port configs to create for this NodeBalancer. Each config needs a unique port and at least one node.

• Optionalfirewall_id?: number

  The ID of the Firewall to assign to the NodeBalancer.

  • A NodeBalancer can have only one Firewall assigned to it.
  • Firewalls control inbound network traffic to NodeBalancers.

• Optionallabel?: string

  Filterable This NodeBalancer's label. These must be unique on your Account.

• region: string

  The ID of the Region to create this NodeBalancer in.

• Optionaltags?: string[]

  An array of Tags applied to this object. Tags are for organizational purposes only.

• Optionalvpcs?: {
      id?: number;
      ipv4_range?: string;
      ipv4_range_auto_assign?: boolean | null;
      nodebalancer_id?: number;
      subnet_id: number;
      vpc_id?: number | null;
  }[]

  You can have only one vpcs in a NodeBalancer configuration. If any of your backend nodes are VPC Linodes, specify the VPC subnet and CIDR range. NodeBalancer routes traffic to backend VPC nodes through this subnet. The specified VPC subnet must exist within the same data center as the NodeBalancer, and the provided IP range must be contained within the subnet's CIDR block. All IP addresses within the specified range must be free and available for assignment. Once the NodeBalancer is created, its VPC cannot be changed.