digitalocean.LoadBalancer
Explore with Pulumi AI
Provides a DigitalOcean Load Balancer resource. This can be used to create, modify, and delete Load Balancers.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const web = new digitalocean.Droplet("web", {
name: "web-1",
size: digitalocean.DropletSlug.DropletS1VCPU1GB,
image: "ubuntu-18-04-x64",
region: digitalocean.Region.NYC3,
});
const _public = new digitalocean.LoadBalancer("public", {
name: "loadbalancer-1",
region: digitalocean.Region.NYC3,
forwardingRules: [{
entryPort: 80,
entryProtocol: "http",
targetPort: 80,
targetProtocol: "http",
}],
healthcheck: {
port: 22,
protocol: "tcp",
},
dropletIds: [web.id],
});
import pulumi
import pulumi_digitalocean as digitalocean
web = digitalocean.Droplet("web",
name="web-1",
size=digitalocean.DropletSlug.DROPLET_S1_VCPU1_GB,
image="ubuntu-18-04-x64",
region=digitalocean.Region.NYC3)
public = digitalocean.LoadBalancer("public",
name="loadbalancer-1",
region=digitalocean.Region.NYC3,
forwarding_rules=[{
"entry_port": 80,
"entry_protocol": "http",
"target_port": 80,
"target_protocol": "http",
}],
healthcheck={
"port": 22,
"protocol": "tcp",
},
droplet_ids=[web.id])
package main
import (
"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
web, err := digitalocean.NewDroplet(ctx, "web", &digitalocean.DropletArgs{
Name: pulumi.String("web-1"),
Size: pulumi.String(digitalocean.DropletSlugDropletS1VCPU1GB),
Image: pulumi.String("ubuntu-18-04-x64"),
Region: pulumi.String(digitalocean.RegionNYC3),
})
if err != nil {
return err
}
_, err = digitalocean.NewLoadBalancer(ctx, "public", &digitalocean.LoadBalancerArgs{
Name: pulumi.String("loadbalancer-1"),
Region: pulumi.String(digitalocean.RegionNYC3),
ForwardingRules: digitalocean.LoadBalancerForwardingRuleArray{
&digitalocean.LoadBalancerForwardingRuleArgs{
EntryPort: pulumi.Int(80),
EntryProtocol: pulumi.String("http"),
TargetPort: pulumi.Int(80),
TargetProtocol: pulumi.String("http"),
},
},
Healthcheck: &digitalocean.LoadBalancerHealthcheckArgs{
Port: pulumi.Int(22),
Protocol: pulumi.String("tcp"),
},
DropletIds: pulumi.IntArray{
web.ID(),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
var web = new DigitalOcean.Droplet("web", new()
{
Name = "web-1",
Size = DigitalOcean.DropletSlug.DropletS1VCPU1GB,
Image = "ubuntu-18-04-x64",
Region = DigitalOcean.Region.NYC3,
});
var @public = new DigitalOcean.LoadBalancer("public", new()
{
Name = "loadbalancer-1",
Region = DigitalOcean.Region.NYC3,
ForwardingRules = new[]
{
new DigitalOcean.Inputs.LoadBalancerForwardingRuleArgs
{
EntryPort = 80,
EntryProtocol = "http",
TargetPort = 80,
TargetProtocol = "http",
},
},
Healthcheck = new DigitalOcean.Inputs.LoadBalancerHealthcheckArgs
{
Port = 22,
Protocol = "tcp",
},
DropletIds = new[]
{
web.Id,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.Droplet;
import com.pulumi.digitalocean.DropletArgs;
import com.pulumi.digitalocean.LoadBalancer;
import com.pulumi.digitalocean.LoadBalancerArgs;
import com.pulumi.digitalocean.inputs.LoadBalancerForwardingRuleArgs;
import com.pulumi.digitalocean.inputs.LoadBalancerHealthcheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var web = new Droplet("web", DropletArgs.builder()
.name("web-1")
.size("s-1vcpu-1gb")
.image("ubuntu-18-04-x64")
.region("nyc3")
.build());
var public_ = new LoadBalancer("public", LoadBalancerArgs.builder()
.name("loadbalancer-1")
.region("nyc3")
.forwardingRules(LoadBalancerForwardingRuleArgs.builder()
.entryPort(80)
.entryProtocol("http")
.targetPort(80)
.targetProtocol("http")
.build())
.healthcheck(LoadBalancerHealthcheckArgs.builder()
.port(22)
.protocol("tcp")
.build())
.dropletIds(web.id())
.build());
}
}
resources:
web:
type: digitalocean:Droplet
properties:
name: web-1
size: s-1vcpu-1gb
image: ubuntu-18-04-x64
region: nyc3
public:
type: digitalocean:LoadBalancer
properties:
name: loadbalancer-1
region: nyc3
forwardingRules:
- entryPort: 80
entryProtocol: http
targetPort: 80
targetProtocol: http
healthcheck:
port: 22
protocol: tcp
dropletIds:
- ${web.id}
When managing certificates attached to the load balancer, make sure to add the create_before_destroy
lifecycle property in order to ensure the certificate is correctly updated when changed. The order of
operations will then be: Create new certificate
> Update loadbalancer with new certificate
->
Delete old certificate
. When doing so, you must also change the name of the certificate,
as there cannot be multiple certificates with the same name in an account.
Create LoadBalancer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LoadBalancer(name: string, args?: LoadBalancerArgs, opts?: CustomResourceOptions);
@overload
def LoadBalancer(resource_name: str,
args: Optional[LoadBalancerArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def LoadBalancer(resource_name: str,
opts: Optional[ResourceOptions] = None,
algorithm: Optional[Union[str, Algorithm]] = None,
disable_lets_encrypt_dns_records: Optional[bool] = None,
domains: Optional[Sequence[LoadBalancerDomainArgs]] = None,
droplet_ids: Optional[Sequence[int]] = None,
droplet_tag: Optional[str] = None,
enable_backend_keepalive: Optional[bool] = None,
enable_proxy_protocol: Optional[bool] = None,
firewall: Optional[LoadBalancerFirewallArgs] = None,
forwarding_rules: Optional[Sequence[LoadBalancerForwardingRuleArgs]] = None,
glb_settings: Optional[LoadBalancerGlbSettingsArgs] = None,
healthcheck: Optional[LoadBalancerHealthcheckArgs] = None,
http_idle_timeout_seconds: Optional[int] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project_id: Optional[str] = None,
redirect_http_to_https: Optional[bool] = None,
region: Optional[Union[str, Region]] = None,
size: Optional[str] = None,
size_unit: Optional[int] = None,
sticky_sessions: Optional[LoadBalancerStickySessionsArgs] = None,
target_load_balancer_ids: Optional[Sequence[str]] = None,
type: Optional[str] = None,
vpc_uuid: Optional[str] = None)
func NewLoadBalancer(ctx *Context, name string, args *LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)
public LoadBalancer(string name, LoadBalancerArgs? args = null, CustomResourceOptions? opts = null)
public LoadBalancer(String name, LoadBalancerArgs args)
public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)
type: digitalocean:LoadBalancer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var loadBalancerResource = new DigitalOcean.LoadBalancer("loadBalancerResource", new()
{
DisableLetsEncryptDnsRecords = false,
Domains = new[]
{
new DigitalOcean.Inputs.LoadBalancerDomainArgs
{
Name = "string",
CertificateName = "string",
IsManaged = false,
SslValidationErrorReasons = new[]
{
"string",
},
VerificationErrorReasons = new[]
{
"string",
},
},
},
DropletIds = new[]
{
0,
},
DropletTag = "string",
EnableBackendKeepalive = false,
EnableProxyProtocol = false,
Firewall = new DigitalOcean.Inputs.LoadBalancerFirewallArgs
{
Allows = new[]
{
"string",
},
Denies = new[]
{
"string",
},
},
ForwardingRules = new[]
{
new DigitalOcean.Inputs.LoadBalancerForwardingRuleArgs
{
EntryPort = 0,
EntryProtocol = "string",
TargetPort = 0,
TargetProtocol = "string",
CertificateName = "string",
TlsPassthrough = false,
},
},
GlbSettings = new DigitalOcean.Inputs.LoadBalancerGlbSettingsArgs
{
TargetPort = 0,
TargetProtocol = "string",
Cdn = new DigitalOcean.Inputs.LoadBalancerGlbSettingsCdnArgs
{
IsEnabled = false,
},
FailoverThreshold = 0,
RegionPriorities =
{
{ "string", 0 },
},
},
Healthcheck = new DigitalOcean.Inputs.LoadBalancerHealthcheckArgs
{
Port = 0,
Protocol = "string",
CheckIntervalSeconds = 0,
HealthyThreshold = 0,
Path = "string",
ResponseTimeoutSeconds = 0,
UnhealthyThreshold = 0,
},
HttpIdleTimeoutSeconds = 0,
Name = "string",
Network = "string",
ProjectId = "string",
RedirectHttpToHttps = false,
Region = "string",
Size = "string",
SizeUnit = 0,
StickySessions = new DigitalOcean.Inputs.LoadBalancerStickySessionsArgs
{
CookieName = "string",
CookieTtlSeconds = 0,
Type = "string",
},
TargetLoadBalancerIds = new[]
{
"string",
},
Type = "string",
VpcUuid = "string",
});
example, err := digitalocean.NewLoadBalancer(ctx, "loadBalancerResource", &digitalocean.LoadBalancerArgs{
DisableLetsEncryptDnsRecords: pulumi.Bool(false),
Domains: digitalocean.LoadBalancerDomainArray{
&digitalocean.LoadBalancerDomainArgs{
Name: pulumi.String("string"),
CertificateName: pulumi.String("string"),
IsManaged: pulumi.Bool(false),
SslValidationErrorReasons: pulumi.StringArray{
pulumi.String("string"),
},
VerificationErrorReasons: pulumi.StringArray{
pulumi.String("string"),
},
},
},
DropletIds: pulumi.IntArray{
pulumi.Int(0),
},
DropletTag: pulumi.String("string"),
EnableBackendKeepalive: pulumi.Bool(false),
EnableProxyProtocol: pulumi.Bool(false),
Firewall: &digitalocean.LoadBalancerFirewallArgs{
Allows: pulumi.StringArray{
pulumi.String("string"),
},
Denies: pulumi.StringArray{
pulumi.String("string"),
},
},
ForwardingRules: digitalocean.LoadBalancerForwardingRuleArray{
&digitalocean.LoadBalancerForwardingRuleArgs{
EntryPort: pulumi.Int(0),
EntryProtocol: pulumi.String("string"),
TargetPort: pulumi.Int(0),
TargetProtocol: pulumi.String("string"),
CertificateName: pulumi.String("string"),
TlsPassthrough: pulumi.Bool(false),
},
},
GlbSettings: &digitalocean.LoadBalancerGlbSettingsArgs{
TargetPort: pulumi.Int(0),
TargetProtocol: pulumi.String("string"),
Cdn: &digitalocean.LoadBalancerGlbSettingsCdnArgs{
IsEnabled: pulumi.Bool(false),
},
FailoverThreshold: pulumi.Int(0),
RegionPriorities: pulumi.IntMap{
"string": pulumi.Int(0),
},
},
Healthcheck: &digitalocean.LoadBalancerHealthcheckArgs{
Port: pulumi.Int(0),
Protocol: pulumi.String("string"),
CheckIntervalSeconds: pulumi.Int(0),
HealthyThreshold: pulumi.Int(0),
Path: pulumi.String("string"),
ResponseTimeoutSeconds: pulumi.Int(0),
UnhealthyThreshold: pulumi.Int(0),
},
HttpIdleTimeoutSeconds: pulumi.Int(0),
Name: pulumi.String("string"),
Network: pulumi.String("string"),
ProjectId: pulumi.String("string"),
RedirectHttpToHttps: pulumi.Bool(false),
Region: pulumi.String("string"),
Size: pulumi.String("string"),
SizeUnit: pulumi.Int(0),
StickySessions: &digitalocean.LoadBalancerStickySessionsArgs{
CookieName: pulumi.String("string"),
CookieTtlSeconds: pulumi.Int(0),
Type: pulumi.String("string"),
},
TargetLoadBalancerIds: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
VpcUuid: pulumi.String("string"),
})
var loadBalancerResource = new LoadBalancer("loadBalancerResource", LoadBalancerArgs.builder()
.disableLetsEncryptDnsRecords(false)
.domains(LoadBalancerDomainArgs.builder()
.name("string")
.certificateName("string")
.isManaged(false)
.sslValidationErrorReasons("string")
.verificationErrorReasons("string")
.build())
.dropletIds(0)
.dropletTag("string")
.enableBackendKeepalive(false)
.enableProxyProtocol(false)
.firewall(LoadBalancerFirewallArgs.builder()
.allows("string")
.denies("string")
.build())
.forwardingRules(LoadBalancerForwardingRuleArgs.builder()
.entryPort(0)
.entryProtocol("string")
.targetPort(0)
.targetProtocol("string")
.certificateName("string")
.tlsPassthrough(false)
.build())
.glbSettings(LoadBalancerGlbSettingsArgs.builder()
.targetPort(0)
.targetProtocol("string")
.cdn(LoadBalancerGlbSettingsCdnArgs.builder()
.isEnabled(false)
.build())
.failoverThreshold(0)
.regionPriorities(Map.of("string", 0))
.build())
.healthcheck(LoadBalancerHealthcheckArgs.builder()
.port(0)
.protocol("string")
.checkIntervalSeconds(0)
.healthyThreshold(0)
.path("string")
.responseTimeoutSeconds(0)
.unhealthyThreshold(0)
.build())
.httpIdleTimeoutSeconds(0)
.name("string")
.network("string")
.projectId("string")
.redirectHttpToHttps(false)
.region("string")
.size("string")
.sizeUnit(0)
.stickySessions(LoadBalancerStickySessionsArgs.builder()
.cookieName("string")
.cookieTtlSeconds(0)
.type("string")
.build())
.targetLoadBalancerIds("string")
.type("string")
.vpcUuid("string")
.build());
load_balancer_resource = digitalocean.LoadBalancer("loadBalancerResource",
disable_lets_encrypt_dns_records=False,
domains=[{
"name": "string",
"certificate_name": "string",
"is_managed": False,
"ssl_validation_error_reasons": ["string"],
"verification_error_reasons": ["string"],
}],
droplet_ids=[0],
droplet_tag="string",
enable_backend_keepalive=False,
enable_proxy_protocol=False,
firewall={
"allows": ["string"],
"denies": ["string"],
},
forwarding_rules=[{
"entry_port": 0,
"entry_protocol": "string",
"target_port": 0,
"target_protocol": "string",
"certificate_name": "string",
"tls_passthrough": False,
}],
glb_settings={
"target_port": 0,
"target_protocol": "string",
"cdn": {
"is_enabled": False,
},
"failover_threshold": 0,
"region_priorities": {
"string": 0,
},
},
healthcheck={
"port": 0,
"protocol": "string",
"check_interval_seconds": 0,
"healthy_threshold": 0,
"path": "string",
"response_timeout_seconds": 0,
"unhealthy_threshold": 0,
},
http_idle_timeout_seconds=0,
name="string",
network="string",
project_id="string",
redirect_http_to_https=False,
region="string",
size="string",
size_unit=0,
sticky_sessions={
"cookie_name": "string",
"cookie_ttl_seconds": 0,
"type": "string",
},
target_load_balancer_ids=["string"],
type="string",
vpc_uuid="string")
const loadBalancerResource = new digitalocean.LoadBalancer("loadBalancerResource", {
disableLetsEncryptDnsRecords: false,
domains: [{
name: "string",
certificateName: "string",
isManaged: false,
sslValidationErrorReasons: ["string"],
verificationErrorReasons: ["string"],
}],
dropletIds: [0],
dropletTag: "string",
enableBackendKeepalive: false,
enableProxyProtocol: false,
firewall: {
allows: ["string"],
denies: ["string"],
},
forwardingRules: [{
entryPort: 0,
entryProtocol: "string",
targetPort: 0,
targetProtocol: "string",
certificateName: "string",
tlsPassthrough: false,
}],
glbSettings: {
targetPort: 0,
targetProtocol: "string",
cdn: {
isEnabled: false,
},
failoverThreshold: 0,
regionPriorities: {
string: 0,
},
},
healthcheck: {
port: 0,
protocol: "string",
checkIntervalSeconds: 0,
healthyThreshold: 0,
path: "string",
responseTimeoutSeconds: 0,
unhealthyThreshold: 0,
},
httpIdleTimeoutSeconds: 0,
name: "string",
network: "string",
projectId: "string",
redirectHttpToHttps: false,
region: "string",
size: "string",
sizeUnit: 0,
stickySessions: {
cookieName: "string",
cookieTtlSeconds: 0,
type: "string",
},
targetLoadBalancerIds: ["string"],
type: "string",
vpcUuid: "string",
});
type: digitalocean:LoadBalancer
properties:
disableLetsEncryptDnsRecords: false
domains:
- certificateName: string
isManaged: false
name: string
sslValidationErrorReasons:
- string
verificationErrorReasons:
- string
dropletIds:
- 0
dropletTag: string
enableBackendKeepalive: false
enableProxyProtocol: false
firewall:
allows:
- string
denies:
- string
forwardingRules:
- certificateName: string
entryPort: 0
entryProtocol: string
targetPort: 0
targetProtocol: string
tlsPassthrough: false
glbSettings:
cdn:
isEnabled: false
failoverThreshold: 0
regionPriorities:
string: 0
targetPort: 0
targetProtocol: string
healthcheck:
checkIntervalSeconds: 0
healthyThreshold: 0
path: string
port: 0
protocol: string
responseTimeoutSeconds: 0
unhealthyThreshold: 0
httpIdleTimeoutSeconds: 0
name: string
network: string
projectId: string
redirectHttpToHttps: false
region: string
size: string
sizeUnit: 0
stickySessions:
cookieName: string
cookieTtlSeconds: 0
type: string
targetLoadBalancerIds:
- string
type: string
vpcUuid: string
LoadBalancer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LoadBalancer resource accepts the following input properties:
- Algorithm
string | Pulumi.
Digital Ocean. Algorithm - Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - Disable
Lets boolEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - Domains
List<Pulumi.
Digital Ocean. Inputs. Load Balancer Domain> - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Droplet
Ids List<int> - A list of the IDs of each droplet to be attached to the Load Balancer.
- Droplet
Tag string - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- Enable
Backend boolKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - Enable
Proxy boolProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - Firewall
Pulumi.
Digital Ocean. Inputs. Load Balancer Firewall - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - Forwarding
Rules List<Pulumi.Digital Ocean. Inputs. Load Balancer Forwarding Rule> - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - Glb
Settings Pulumi.Digital Ocean. Inputs. Load Balancer Glb Settings - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Healthcheck
Pulumi.
Digital Ocean. Inputs. Load Balancer Healthcheck - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - Http
Idle intTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- Name string
- The Load Balancer name
- Network string
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - Project
Id string - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- Redirect
Http boolTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - Region
string | Pulumi.
Digital Ocean. Region - The region to start in
- Size string
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - Size
Unit int - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - Sticky
Sessions Pulumi.Digital Ocean. Inputs. Load Balancer Sticky Sessions - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - Target
Load List<string>Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- Type string
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - Vpc
Uuid string - The ID of the VPC where the load balancer will be located.
- Algorithm string | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - Disable
Lets boolEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - Domains
[]Load
Balancer Domain Args - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Droplet
Ids []int - A list of the IDs of each droplet to be attached to the Load Balancer.
- Droplet
Tag string - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- Enable
Backend boolKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - Enable
Proxy boolProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - Firewall
Load
Balancer Firewall Args - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - Forwarding
Rules []LoadBalancer Forwarding Rule Args - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - Glb
Settings LoadBalancer Glb Settings Args - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Healthcheck
Load
Balancer Healthcheck Args - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - Http
Idle intTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- Name string
- The Load Balancer name
- Network string
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - Project
Id string - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- Redirect
Http boolTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - Region string | Region
- The region to start in
- Size string
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - Size
Unit int - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - Sticky
Sessions LoadBalancer Sticky Sessions Args - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - Target
Load []stringBalancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- Type string
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - Vpc
Uuid string - The ID of the VPC where the load balancer will be located.
- algorithm String | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable
Lets BooleanEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains
List<Load
Balancer Domain> - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet
Ids List<Integer> - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet
Tag String - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable
Backend BooleanKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable
Proxy BooleanProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall
Load
Balancer Firewall - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding
Rules List<LoadBalancer Forwarding Rule> - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb
Settings LoadBalancer Glb Settings - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck
Load
Balancer Healthcheck - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http
Idle IntegerTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- name String
- The Load Balancer name
- network String
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project
Id String - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect
Http BooleanTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region String | Region
- The region to start in
- size String
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size
Unit Integer - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - sticky
Sessions LoadBalancer Sticky Sessions - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target
Load List<String>Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type String
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc
Uuid String - The ID of the VPC where the load balancer will be located.
- algorithm string | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable
Lets booleanEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains
Load
Balancer Domain[] - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet
Ids number[] - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet
Tag string - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable
Backend booleanKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable
Proxy booleanProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall
Load
Balancer Firewall - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding
Rules LoadBalancer Forwarding Rule[] - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb
Settings LoadBalancer Glb Settings - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck
Load
Balancer Healthcheck - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http
Idle numberTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- name string
- The Load Balancer name
- network string
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project
Id string - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect
Http booleanTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region string | Region
- The region to start in
- size string
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size
Unit number - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - sticky
Sessions LoadBalancer Sticky Sessions - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target
Load string[]Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type string
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc
Uuid string - The ID of the VPC where the load balancer will be located.
- algorithm str | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable_
lets_ boolencrypt_ dns_ records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains
Sequence[Load
Balancer Domain Args] - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet_
ids Sequence[int] - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet_
tag str - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable_
backend_ boolkeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable_
proxy_ boolprotocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall
Load
Balancer Firewall Args - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding_
rules Sequence[LoadBalancer Forwarding Rule Args] - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb_
settings LoadBalancer Glb Settings Args - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck
Load
Balancer Healthcheck Args - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http_
idle_ inttimeout_ seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- name str
- The Load Balancer name
- network str
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project_
id str - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect_
http_ boolto_ https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region str | Region
- The region to start in
- size str
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size_
unit int - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - sticky_
sessions LoadBalancer Sticky Sessions Args - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target_
load_ Sequence[str]balancer_ ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type str
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc_
uuid str - The ID of the VPC where the load balancer will be located.
- algorithm
String | "round_
robin" | "least_ connections" - Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable
Lets BooleanEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains List<Property Map>
- A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet
Ids List<Number> - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet
Tag String - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable
Backend BooleanKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable
Proxy BooleanProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall Property Map
- A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding
Rules List<Property Map> - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb
Settings Property Map - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck Property Map
- A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http
Idle NumberTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- name String
- The Load Balancer name
- network String
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project
Id String - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect
Http BooleanTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region String | "nyc1" | "nyc2" | "nyc3" | "sgp1" | "lon1" | "ams2" | "ams3" | "fra1" | "tor1" | "sfo1" | "sfo2" | "sfo3" | "blr1" | "syd1"
- The region to start in
- size String
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size
Unit Number - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - sticky
Sessions Property Map - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target
Load List<String>Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type String
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc
Uuid String - The ID of the VPC where the load balancer will be located.
Outputs
All input properties are implicitly available as output properties. Additionally, the LoadBalancer resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip string
- The ip of the Load Balancer
- Load
Balancer stringUrn - The uniform resource name for the Load Balancer
- Status string
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip string
- The ip of the Load Balancer
- Load
Balancer stringUrn - The uniform resource name for the Load Balancer
- Status string
- id String
- The provider-assigned unique ID for this managed resource.
- ip String
- The ip of the Load Balancer
- load
Balancer StringUrn - The uniform resource name for the Load Balancer
- status String
- id string
- The provider-assigned unique ID for this managed resource.
- ip string
- The ip of the Load Balancer
- load
Balancer stringUrn - The uniform resource name for the Load Balancer
- status string
- id str
- The provider-assigned unique ID for this managed resource.
- ip str
- The ip of the Load Balancer
- load_
balancer_ strurn - The uniform resource name for the Load Balancer
- status str
- id String
- The provider-assigned unique ID for this managed resource.
- ip String
- The ip of the Load Balancer
- load
Balancer StringUrn - The uniform resource name for the Load Balancer
- status String
Look up Existing LoadBalancer Resource
Get an existing LoadBalancer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: LoadBalancerState, opts?: CustomResourceOptions): LoadBalancer
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
algorithm: Optional[Union[str, Algorithm]] = None,
disable_lets_encrypt_dns_records: Optional[bool] = None,
domains: Optional[Sequence[LoadBalancerDomainArgs]] = None,
droplet_ids: Optional[Sequence[int]] = None,
droplet_tag: Optional[str] = None,
enable_backend_keepalive: Optional[bool] = None,
enable_proxy_protocol: Optional[bool] = None,
firewall: Optional[LoadBalancerFirewallArgs] = None,
forwarding_rules: Optional[Sequence[LoadBalancerForwardingRuleArgs]] = None,
glb_settings: Optional[LoadBalancerGlbSettingsArgs] = None,
healthcheck: Optional[LoadBalancerHealthcheckArgs] = None,
http_idle_timeout_seconds: Optional[int] = None,
ip: Optional[str] = None,
load_balancer_urn: Optional[str] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project_id: Optional[str] = None,
redirect_http_to_https: Optional[bool] = None,
region: Optional[Union[str, Region]] = None,
size: Optional[str] = None,
size_unit: Optional[int] = None,
status: Optional[str] = None,
sticky_sessions: Optional[LoadBalancerStickySessionsArgs] = None,
target_load_balancer_ids: Optional[Sequence[str]] = None,
type: Optional[str] = None,
vpc_uuid: Optional[str] = None) -> LoadBalancer
func GetLoadBalancer(ctx *Context, name string, id IDInput, state *LoadBalancerState, opts ...ResourceOption) (*LoadBalancer, error)
public static LoadBalancer Get(string name, Input<string> id, LoadBalancerState? state, CustomResourceOptions? opts = null)
public static LoadBalancer get(String name, Output<String> id, LoadBalancerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Algorithm
string | Pulumi.
Digital Ocean. Algorithm - Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - Disable
Lets boolEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - Domains
List<Pulumi.
Digital Ocean. Inputs. Load Balancer Domain> - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Droplet
Ids List<int> - A list of the IDs of each droplet to be attached to the Load Balancer.
- Droplet
Tag string - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- Enable
Backend boolKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - Enable
Proxy boolProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - Firewall
Pulumi.
Digital Ocean. Inputs. Load Balancer Firewall - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - Forwarding
Rules List<Pulumi.Digital Ocean. Inputs. Load Balancer Forwarding Rule> - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - Glb
Settings Pulumi.Digital Ocean. Inputs. Load Balancer Glb Settings - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Healthcheck
Pulumi.
Digital Ocean. Inputs. Load Balancer Healthcheck - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - Http
Idle intTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- Ip string
- The ip of the Load Balancer
- Load
Balancer stringUrn - The uniform resource name for the Load Balancer
- Name string
- The Load Balancer name
- Network string
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - Project
Id string - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- Redirect
Http boolTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - Region
string | Pulumi.
Digital Ocean. Region - The region to start in
- Size string
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - Size
Unit int - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - Status string
- Sticky
Sessions Pulumi.Digital Ocean. Inputs. Load Balancer Sticky Sessions - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - Target
Load List<string>Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- Type string
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - Vpc
Uuid string - The ID of the VPC where the load balancer will be located.
- Algorithm string | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - Disable
Lets boolEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - Domains
[]Load
Balancer Domain Args - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Droplet
Ids []int - A list of the IDs of each droplet to be attached to the Load Balancer.
- Droplet
Tag string - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- Enable
Backend boolKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - Enable
Proxy boolProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - Firewall
Load
Balancer Firewall Args - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - Forwarding
Rules []LoadBalancer Forwarding Rule Args - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - Glb
Settings LoadBalancer Glb Settings Args - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - Healthcheck
Load
Balancer Healthcheck Args - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - Http
Idle intTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- Ip string
- The ip of the Load Balancer
- Load
Balancer stringUrn - The uniform resource name for the Load Balancer
- Name string
- The Load Balancer name
- Network string
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - Project
Id string - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- Redirect
Http boolTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - Region string | Region
- The region to start in
- Size string
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - Size
Unit int - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - Status string
- Sticky
Sessions LoadBalancer Sticky Sessions Args - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - Target
Load []stringBalancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- Type string
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - Vpc
Uuid string - The ID of the VPC where the load balancer will be located.
- algorithm String | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable
Lets BooleanEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains
List<Load
Balancer Domain> - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet
Ids List<Integer> - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet
Tag String - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable
Backend BooleanKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable
Proxy BooleanProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall
Load
Balancer Firewall - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding
Rules List<LoadBalancer Forwarding Rule> - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb
Settings LoadBalancer Glb Settings - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck
Load
Balancer Healthcheck - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http
Idle IntegerTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- ip String
- The ip of the Load Balancer
- load
Balancer StringUrn - The uniform resource name for the Load Balancer
- name String
- The Load Balancer name
- network String
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project
Id String - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect
Http BooleanTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region String | Region
- The region to start in
- size String
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size
Unit Integer - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - status String
- sticky
Sessions LoadBalancer Sticky Sessions - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target
Load List<String>Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type String
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc
Uuid String - The ID of the VPC where the load balancer will be located.
- algorithm string | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable
Lets booleanEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains
Load
Balancer Domain[] - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet
Ids number[] - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet
Tag string - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable
Backend booleanKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable
Proxy booleanProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall
Load
Balancer Firewall - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding
Rules LoadBalancer Forwarding Rule[] - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb
Settings LoadBalancer Glb Settings - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck
Load
Balancer Healthcheck - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http
Idle numberTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- ip string
- The ip of the Load Balancer
- load
Balancer stringUrn - The uniform resource name for the Load Balancer
- name string
- The Load Balancer name
- network string
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project
Id string - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect
Http booleanTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region string | Region
- The region to start in
- size string
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size
Unit number - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - status string
- sticky
Sessions LoadBalancer Sticky Sessions - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target
Load string[]Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type string
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc
Uuid string - The ID of the VPC where the load balancer will be located.
- algorithm str | Algorithm
- Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable_
lets_ boolencrypt_ dns_ records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains
Sequence[Load
Balancer Domain Args] - A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet_
ids Sequence[int] - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet_
tag str - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable_
backend_ boolkeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable_
proxy_ boolprotocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall
Load
Balancer Firewall Args - A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding_
rules Sequence[LoadBalancer Forwarding Rule Args] - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb_
settings LoadBalancer Glb Settings Args - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck
Load
Balancer Healthcheck Args - A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http_
idle_ inttimeout_ seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- ip str
- The ip of the Load Balancer
- load_
balancer_ strurn - The uniform resource name for the Load Balancer
- name str
- The Load Balancer name
- network str
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project_
id str - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect_
http_ boolto_ https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region str | Region
- The region to start in
- size str
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size_
unit int - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - status str
- sticky_
sessions LoadBalancer Sticky Sessions Args - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target_
load_ Sequence[str]balancer_ ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type str
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc_
uuid str - The ID of the VPC where the load balancer will be located.
- algorithm
String | "round_
robin" | "least_ connections" - Deprecated This field has been deprecated. You can no longer specify an algorithm for load balancers.
or
least_connections
. The default value isround_robin
. - disable
Lets BooleanEncrypt Dns Records - A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. Default value is
false
. - domains List<Property Map>
- A list of
domains
required to ingress traffic to a Global Load Balancer. Thedomains
block is documented below. NOTE: this is a closed beta feature and not available for public use. - droplet
Ids List<Number> - A list of the IDs of each droplet to be attached to the Load Balancer.
- droplet
Tag String - The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.
- enable
Backend BooleanKeepalive - A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. Default value is
false
. - enable
Proxy BooleanProtocol - A boolean value indicating whether PROXY
Protocol should be used to pass information from connecting client requests to
the backend service. Default value is
false
. - firewall Property Map
- A block containing rules for allowing/denying traffic to the Load Balancer. The
firewall
block is documented below. Only 1 firewall is allowed. - forwarding
Rules List<Property Map> - A list of
forwarding_rule
to be assigned to the Load Balancer. Theforwarding_rule
block is documented below. - glb
Settings Property Map - A block containing
glb_settings
required to define target rules for a Global Load Balancer. Theglb_settings
block is documented below. NOTE: this is a closed beta feature and not available for public use. - healthcheck Property Map
- A
healthcheck
block to be assigned to the Load Balancer. Thehealthcheck
block is documented below. Only 1 healthcheck is allowed. - http
Idle NumberTimeout Seconds - Specifies the idle timeout for HTTPS connections on the load balancer in seconds.
- ip String
- The ip of the Load Balancer
- load
Balancer StringUrn - The uniform resource name for the Load Balancer
- name String
- The Load Balancer name
- network String
- The type of network the Load Balancer is accessible from. It must be either of
INTERNAL
orEXTERNAL
. Defaults toEXTERNAL
. NOTE: non-EXTERNAL
type may be part of closed beta feature and not available for public use. - project
Id String - The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project.
- redirect
Http BooleanTo Https - A boolean value indicating whether
HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443.
Default value is
false
. - region String | "nyc1" | "nyc2" | "nyc3" | "sgp1" | "lon1" | "ams2" | "ams3" | "fra1" | "tor1" | "sfo1" | "sfo2" | "sfo3" | "blr1" | "syd1"
- The region to start in
- size String
- The size of the Load Balancer. It must be either
lb-small
,lb-medium
, orlb-large
. Defaults tolb-small
. Only one ofsize
orsize_unit
may be provided. - size
Unit Number - The size of the Load Balancer. It must be in the range (1, 100). Defaults to
1
. Only one ofsize
orsize_unit
may be provided. - status String
- sticky
Sessions Property Map - A
sticky_sessions
block to be assigned to the Load Balancer. Thesticky_sessions
block is documented below. Only 1 sticky_sessions block is allowed. - target
Load List<String>Balancer Ids - A list of Load Balancer IDs to be attached behind a Global Load Balancer. NOTE: this is a closed beta feature and not available for public use.
- type String
- The type of the Load Balancer. It must be either of
REGIONAL
orGLOBAL
. Defaults toREGIONAL
. NOTE: non-REGIONAL
type may be part of closed beta feature and not available for public use. - vpc
Uuid String - The ID of the VPC where the load balancer will be located.
Supporting Types
Algorithm, AlgorithmArgs
- Round
Robin - round_robin
- Least
Connections - least_connections
- Algorithm
Round Robin - round_robin
- Algorithm
Least Connections - least_connections
- Round
Robin - round_robin
- Least
Connections - least_connections
- Round
Robin - round_robin
- Least
Connections - least_connections
- ROUND_ROBIN
- round_robin
- LEAST_CONNECTIONS
- least_connections
- "round_
robin" - round_robin
- "least_
connections" - least_connections
LoadBalancerDomain, LoadBalancerDomainArgs
- Name string
- The domain name to be used for ingressing traffic to a Global Load Balancer.
- Certificate
Name string - name of certificate required for TLS handshaking
- Is
Managed bool - Control flag to specify whether the domain is managed by DigitalOcean.
- Ssl
Validation List<string>Error Reasons - list of domain SSL validation errors
- Verification
Error List<string>Reasons - list of domain verification errors
- Name string
- The domain name to be used for ingressing traffic to a Global Load Balancer.
- Certificate
Name string - name of certificate required for TLS handshaking
- Is
Managed bool - Control flag to specify whether the domain is managed by DigitalOcean.
- Ssl
Validation []stringError Reasons - list of domain SSL validation errors
- Verification
Error []stringReasons - list of domain verification errors
- name String
- The domain name to be used for ingressing traffic to a Global Load Balancer.
- certificate
Name String - name of certificate required for TLS handshaking
- is
Managed Boolean - Control flag to specify whether the domain is managed by DigitalOcean.
- ssl
Validation List<String>Error Reasons - list of domain SSL validation errors
- verification
Error List<String>Reasons - list of domain verification errors
- name string
- The domain name to be used for ingressing traffic to a Global Load Balancer.
- certificate
Name string - name of certificate required for TLS handshaking
- is
Managed boolean - Control flag to specify whether the domain is managed by DigitalOcean.
- ssl
Validation string[]Error Reasons - list of domain SSL validation errors
- verification
Error string[]Reasons - list of domain verification errors
- name str
- The domain name to be used for ingressing traffic to a Global Load Balancer.
- certificate_
name str - name of certificate required for TLS handshaking
- is_
managed bool - Control flag to specify whether the domain is managed by DigitalOcean.
- ssl_
validation_ Sequence[str]error_ reasons - list of domain SSL validation errors
- verification_
error_ Sequence[str]reasons - list of domain verification errors
- name String
- The domain name to be used for ingressing traffic to a Global Load Balancer.
- certificate
Name String - name of certificate required for TLS handshaking
- is
Managed Boolean - Control flag to specify whether the domain is managed by DigitalOcean.
- ssl
Validation List<String>Error Reasons - list of domain SSL validation errors
- verification
Error List<String>Reasons - list of domain verification errors
LoadBalancerFirewall, LoadBalancerFirewallArgs
- Allows List<string>
- A list of strings describing allow rules. Must be colon delimited strings of the form
{type}:{source}
- Ex.
deny = ["cidr:1.2.0.0/16", "ip:2.3.4.5"]
orallow = ["ip:1.2.3.4", "cidr:2.3.4.0/24"]
- Ex.
- Denies List<string>
- A list of strings describing deny rules. Must be colon delimited strings of the form
{type}:{source}
- Allows []string
- A list of strings describing allow rules. Must be colon delimited strings of the form
{type}:{source}
- Ex.
deny = ["cidr:1.2.0.0/16", "ip:2.3.4.5"]
orallow = ["ip:1.2.3.4", "cidr:2.3.4.0/24"]
- Ex.
- Denies []string
- A list of strings describing deny rules. Must be colon delimited strings of the form
{type}:{source}
- allows List<String>
- A list of strings describing allow rules. Must be colon delimited strings of the form
{type}:{source}
- Ex.
deny = ["cidr:1.2.0.0/16", "ip:2.3.4.5"]
orallow = ["ip:1.2.3.4", "cidr:2.3.4.0/24"]
- Ex.
- denies List<String>
- A list of strings describing deny rules. Must be colon delimited strings of the form
{type}:{source}
- allows string[]
- A list of strings describing allow rules. Must be colon delimited strings of the form
{type}:{source}
- Ex.
deny = ["cidr:1.2.0.0/16", "ip:2.3.4.5"]
orallow = ["ip:1.2.3.4", "cidr:2.3.4.0/24"]
- Ex.
- denies string[]
- A list of strings describing deny rules. Must be colon delimited strings of the form
{type}:{source}
- allows Sequence[str]
- A list of strings describing allow rules. Must be colon delimited strings of the form
{type}:{source}
- Ex.
deny = ["cidr:1.2.0.0/16", "ip:2.3.4.5"]
orallow = ["ip:1.2.3.4", "cidr:2.3.4.0/24"]
- Ex.
- denies Sequence[str]
- A list of strings describing deny rules. Must be colon delimited strings of the form
{type}:{source}
- allows List<String>
- A list of strings describing allow rules. Must be colon delimited strings of the form
{type}:{source}
- Ex.
deny = ["cidr:1.2.0.0/16", "ip:2.3.4.5"]
orallow = ["ip:1.2.3.4", "cidr:2.3.4.0/24"]
- Ex.
- denies List<String>
- A list of strings describing deny rules. Must be colon delimited strings of the form
{type}:{source}
LoadBalancerForwardingRule, LoadBalancerForwardingRuleArgs
- Entry
Port int - An integer representing the port on which the Load Balancer instance will listen.
- Entry
Protocol string - The protocol used for traffic to the Load Balancer. The possible values are:
http
,https
,http2
,http3
,tcp
, orudp
. - Target
Port int - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
- Target
Protocol string - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
,https
,http2
,tcp
, orudp
. - Certificate
Id string - Deprecated The ID of the TLS certificate to be used for SSL termination.
- Certificate
Name string - The unique name of the TLS certificate to be used for SSL termination.
- Tls
Passthrough bool - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is
false
.
- Entry
Port int - An integer representing the port on which the Load Balancer instance will listen.
- Entry
Protocol string - The protocol used for traffic to the Load Balancer. The possible values are:
http
,https
,http2
,http3
,tcp
, orudp
. - Target
Port int - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
- Target
Protocol string - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
,https
,http2
,tcp
, orudp
. - Certificate
Id string - Deprecated The ID of the TLS certificate to be used for SSL termination.
- Certificate
Name string - The unique name of the TLS certificate to be used for SSL termination.
- Tls
Passthrough bool - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is
false
.
- entry
Port Integer - An integer representing the port on which the Load Balancer instance will listen.
- entry
Protocol String - The protocol used for traffic to the Load Balancer. The possible values are:
http
,https
,http2
,http3
,tcp
, orudp
. - target
Port Integer - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
- target
Protocol String - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
,https
,http2
,tcp
, orudp
. - certificate
Id String - Deprecated The ID of the TLS certificate to be used for SSL termination.
- certificate
Name String - The unique name of the TLS certificate to be used for SSL termination.
- tls
Passthrough Boolean - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is
false
.
- entry
Port number - An integer representing the port on which the Load Balancer instance will listen.
- entry
Protocol string - The protocol used for traffic to the Load Balancer. The possible values are:
http
,https
,http2
,http3
,tcp
, orudp
. - target
Port number - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
- target
Protocol string - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
,https
,http2
,tcp
, orudp
. - certificate
Id string - Deprecated The ID of the TLS certificate to be used for SSL termination.
- certificate
Name string - The unique name of the TLS certificate to be used for SSL termination.
- tls
Passthrough boolean - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is
false
.
- entry_
port int - An integer representing the port on which the Load Balancer instance will listen.
- entry_
protocol str - The protocol used for traffic to the Load Balancer. The possible values are:
http
,https
,http2
,http3
,tcp
, orudp
. - target_
port int - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
- target_
protocol str - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
,https
,http2
,tcp
, orudp
. - certificate_
id str - Deprecated The ID of the TLS certificate to be used for SSL termination.
- certificate_
name str - The unique name of the TLS certificate to be used for SSL termination.
- tls_
passthrough bool - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is
false
.
- entry
Port Number - An integer representing the port on which the Load Balancer instance will listen.
- entry
Protocol String - The protocol used for traffic to the Load Balancer. The possible values are:
http
,https
,http2
,http3
,tcp
, orudp
. - target
Port Number - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
- target
Protocol String - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
,https
,http2
,tcp
, orudp
. - certificate
Id String - Deprecated The ID of the TLS certificate to be used for SSL termination.
- certificate
Name String - The unique name of the TLS certificate to be used for SSL termination.
- tls
Passthrough Boolean - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is
false
.
LoadBalancerGlbSettings, LoadBalancerGlbSettingsArgs
- Target
Port int - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic. The possible values are:
80
forhttp
and443
forhttps
. - Target
Protocol string - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
andhttps
. - Cdn
Pulumi.
Digital Ocean. Inputs. Load Balancer Glb Settings Cdn - CDN configuration supporting the following:
- Failover
Threshold int - fail-over threshold
- Region
Priorities Dictionary<string, int> - region priority map
- Target
Port int - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic. The possible values are:
80
forhttp
and443
forhttps
. - Target
Protocol string - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
andhttps
. - Cdn
Load
Balancer Glb Settings Cdn - CDN configuration supporting the following:
- Failover
Threshold int - fail-over threshold
- Region
Priorities map[string]int - region priority map
- target
Port Integer - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic. The possible values are:
80
forhttp
and443
forhttps
. - target
Protocol String - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
andhttps
. - cdn
Load
Balancer Glb Settings Cdn - CDN configuration supporting the following:
- failover
Threshold Integer - fail-over threshold
- region
Priorities Map<String,Integer> - region priority map
- target
Port number - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic. The possible values are:
80
forhttp
and443
forhttps
. - target
Protocol string - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
andhttps
. - cdn
Load
Balancer Glb Settings Cdn - CDN configuration supporting the following:
- failover
Threshold number - fail-over threshold
- region
Priorities {[key: string]: number} - region priority map
- target_
port int - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic. The possible values are:
80
forhttp
and443
forhttps
. - target_
protocol str - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
andhttps
. - cdn
Load
Balancer Glb Settings Cdn - CDN configuration supporting the following:
- failover_
threshold int - fail-over threshold
- region_
priorities Mapping[str, int] - region priority map
- target
Port Number - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic. The possible values are:
80
forhttp
and443
forhttps
. - target
Protocol String - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are:
http
andhttps
. - cdn Property Map
- CDN configuration supporting the following:
- failover
Threshold Number - fail-over threshold
- region
Priorities Map<Number> - region priority map
LoadBalancerGlbSettingsCdn, LoadBalancerGlbSettingsCdnArgs
- Is
Enabled bool - Control flag to specify if caching is enabled.
- Is
Enabled bool - Control flag to specify if caching is enabled.
- is
Enabled Boolean - Control flag to specify if caching is enabled.
- is
Enabled boolean - Control flag to specify if caching is enabled.
- is_
enabled bool - Control flag to specify if caching is enabled.
- is
Enabled Boolean - Control flag to specify if caching is enabled.
LoadBalancerHealthcheck, LoadBalancerHealthcheckArgs
- Port int
- An integer representing the port on the backend Droplets on which the health check will attempt a connection.
- Protocol string
- The protocol used for health checks sent to the backend Droplets. The possible values are
http
,https
ortcp
. - Check
Interval intSeconds - The number of seconds between two consecutive health checks. If not specified, the default value is
10
. - Healthy
Threshold int - The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is
5
. - Path string
- The path on the backend Droplets to which the Load Balancer instance will send a request.
- Response
Timeout intSeconds - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is
5
. - Unhealthy
Threshold int - The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is
3
.
- Port int
- An integer representing the port on the backend Droplets on which the health check will attempt a connection.
- Protocol string
- The protocol used for health checks sent to the backend Droplets. The possible values are
http
,https
ortcp
. - Check
Interval intSeconds - The number of seconds between two consecutive health checks. If not specified, the default value is
10
. - Healthy
Threshold int - The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is
5
. - Path string
- The path on the backend Droplets to which the Load Balancer instance will send a request.
- Response
Timeout intSeconds - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is
5
. - Unhealthy
Threshold int - The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is
3
.
- port Integer
- An integer representing the port on the backend Droplets on which the health check will attempt a connection.
- protocol String
- The protocol used for health checks sent to the backend Droplets. The possible values are
http
,https
ortcp
. - check
Interval IntegerSeconds - The number of seconds between two consecutive health checks. If not specified, the default value is
10
. - healthy
Threshold Integer - The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is
5
. - path String
- The path on the backend Droplets to which the Load Balancer instance will send a request.
- response
Timeout IntegerSeconds - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is
5
. - unhealthy
Threshold Integer - The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is
3
.
- port number
- An integer representing the port on the backend Droplets on which the health check will attempt a connection.
- protocol string
- The protocol used for health checks sent to the backend Droplets. The possible values are
http
,https
ortcp
. - check
Interval numberSeconds - The number of seconds between two consecutive health checks. If not specified, the default value is
10
. - healthy
Threshold number - The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is
5
. - path string
- The path on the backend Droplets to which the Load Balancer instance will send a request.
- response
Timeout numberSeconds - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is
5
. - unhealthy
Threshold number - The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is
3
.
- port int
- An integer representing the port on the backend Droplets on which the health check will attempt a connection.
- protocol str
- The protocol used for health checks sent to the backend Droplets. The possible values are
http
,https
ortcp
. - check_
interval_ intseconds - The number of seconds between two consecutive health checks. If not specified, the default value is
10
. - healthy_
threshold int - The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is
5
. - path str
- The path on the backend Droplets to which the Load Balancer instance will send a request.
- response_
timeout_ intseconds - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is
5
. - unhealthy_
threshold int - The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is
3
.
- port Number
- An integer representing the port on the backend Droplets on which the health check will attempt a connection.
- protocol String
- The protocol used for health checks sent to the backend Droplets. The possible values are
http
,https
ortcp
. - check
Interval NumberSeconds - The number of seconds between two consecutive health checks. If not specified, the default value is
10
. - healthy
Threshold Number - The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool. If not specified, the default value is
5
. - path String
- The path on the backend Droplets to which the Load Balancer instance will send a request.
- response
Timeout NumberSeconds - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is
5
. - unhealthy
Threshold Number - The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool. If not specified, the default value is
3
.
LoadBalancerStickySessions, LoadBalancerStickySessionsArgs
- string
- The name to be used for the cookie sent to the client. This attribute is required when using
cookies
for the sticky sessions type. - int
- The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using
cookies
for the sticky sessions type. - Type string
- An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookies
ornone
. If not specified, the default value isnone
.
- string
- The name to be used for the cookie sent to the client. This attribute is required when using
cookies
for the sticky sessions type. - int
- The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using
cookies
for the sticky sessions type. - Type string
- An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookies
ornone
. If not specified, the default value isnone
.
- String
- The name to be used for the cookie sent to the client. This attribute is required when using
cookies
for the sticky sessions type. - Integer
- The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using
cookies
for the sticky sessions type. - type String
- An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookies
ornone
. If not specified, the default value isnone
.
- string
- The name to be used for the cookie sent to the client. This attribute is required when using
cookies
for the sticky sessions type. - number
- The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using
cookies
for the sticky sessions type. - type string
- An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookies
ornone
. If not specified, the default value isnone
.
- str
- The name to be used for the cookie sent to the client. This attribute is required when using
cookies
for the sticky sessions type. - int
- The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using
cookies
for the sticky sessions type. - type str
- An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookies
ornone
. If not specified, the default value isnone
.
- String
- The name to be used for the cookie sent to the client. This attribute is required when using
cookies
for the sticky sessions type. - Number
- The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using
cookies
for the sticky sessions type. - type String
- An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookies
ornone
. If not specified, the default value isnone
.
Region, RegionArgs
- NYC1
- nyc1
- NYC2
- nyc2
- NYC3
- nyc3
- SGP1
- sgp1
- LON1
- lon1
- AMS2
- ams2
- AMS3
- ams3
- FRA1
- fra1
- TOR1
- tor1
- SFO1
- sfo1
- SFO2
- sfo2
- SFO3
- sfo3
- BLR1
- blr1
- SYD1
- syd1
- Region
NYC1 - nyc1
- Region
NYC2 - nyc2
- Region
NYC3 - nyc3
- Region
SGP1 - sgp1
- Region
LON1 - lon1
- Region
AMS2 - ams2
- Region
AMS3 - ams3
- Region
FRA1 - fra1
- Region
TOR1 - tor1
- Region
SFO1 - sfo1
- Region
SFO2 - sfo2
- Region
SFO3 - sfo3
- Region
BLR1 - blr1
- Region
SYD1 - syd1
- NYC1
- nyc1
- NYC2
- nyc2
- NYC3
- nyc3
- SGP1
- sgp1
- LON1
- lon1
- AMS2
- ams2
- AMS3
- ams3
- FRA1
- fra1
- TOR1
- tor1
- SFO1
- sfo1
- SFO2
- sfo2
- SFO3
- sfo3
- BLR1
- blr1
- SYD1
- syd1
- NYC1
- nyc1
- NYC2
- nyc2
- NYC3
- nyc3
- SGP1
- sgp1
- LON1
- lon1
- AMS2
- ams2
- AMS3
- ams3
- FRA1
- fra1
- TOR1
- tor1
- SFO1
- sfo1
- SFO2
- sfo2
- SFO3
- sfo3
- BLR1
- blr1
- SYD1
- syd1
- NYC1
- nyc1
- NYC2
- nyc2
- NYC3
- nyc3
- SGP1
- sgp1
- LON1
- lon1
- AMS2
- ams2
- AMS3
- ams3
- FRA1
- fra1
- TOR1
- tor1
- SFO1
- sfo1
- SFO2
- sfo2
- SFO3
- sfo3
- BLR1
- blr1
- SYD1
- syd1
- "nyc1"
- nyc1
- "nyc2"
- nyc2
- "nyc3"
- nyc3
- "sgp1"
- sgp1
- "lon1"
- lon1
- "ams2"
- ams2
- "ams3"
- ams3
- "fra1"
- fra1
- "tor1"
- tor1
- "sfo1"
- sfo1
- "sfo2"
- sfo2
- "sfo3"
- sfo3
- "blr1"
- blr1
- "syd1"
- syd1
Import
Load Balancers can be imported using the id
, e.g.
$ pulumi import digitalocean:index/loadBalancer:LoadBalancer myloadbalancer 4de7ac8b-495b-4884-9a69-1050c6793cd6
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
digitalocean
Terraform Provider.