LoadBalancerArgs

data class LoadBalancerArgs(val accessLogs: Output<LoadBalancerAccessLogsArgs>? = null, val clientKeepAlive: Output<Int>? = null, val connectionLogs: Output<LoadBalancerConnectionLogsArgs>? = null, val customerOwnedIpv4Pool: Output<String>? = null, val desyncMitigationMode: Output<String>? = null, val dnsRecordClientRoutingPolicy: Output<String>? = null, val dropInvalidHeaderFields: Output<Boolean>? = null, val enableCrossZoneLoadBalancing: Output<Boolean>? = null, val enableDeletionProtection: Output<Boolean>? = null, val enableHttp2: Output<Boolean>? = null, val enableTlsVersionAndCipherSuiteHeaders: Output<Boolean>? = null, val enableWafFailOpen: Output<Boolean>? = null, val enableXffClientPort: Output<Boolean>? = null, val enableZonalShift: Output<Boolean>? = null, val enforceSecurityGroupInboundRulesOnPrivateLinkTraffic: Output<String>? = null, val idleTimeout: Output<Int>? = null, val internal: Output<Boolean>? = null, val ipAddressType: Output<String>? = null, val ipamPools: Output<LoadBalancerIpamPoolsArgs>? = null, val loadBalancerType: Output<String>? = null, val name: Output<String>? = null, val namePrefix: Output<String>? = null, val preserveHostHeader: Output<Boolean>? = null, val securityGroups: Output<List<String>>? = null, val subnetMappings: Output<List<LoadBalancerSubnetMappingArgs>>? = null, val subnets: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null, val xffHeaderProcessingMode: Output<String>? = null) : ConvertibleToJava<LoadBalancerArgs>

Provides a Load Balancer resource.

Note: aws.alb.LoadBalancer is known as aws.lb.LoadBalancer. The functionality is identical.

Example Usage

Application Load Balancer

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.lb.LoadBalancer("test", {
name: "test-lb-tf",
internal: false,
loadBalancerType: "application",
securityGroups: [lbSg&#46;id],
subnets: .map(subnet => (subnet.id)),
enableDeletionProtection: true,
accessLogs: {
bucket: lbLogs.id,
prefix: "test-lb",
enabled: true,
},
tags: {
Environment: "production",
},
});
import pulumi
import pulumi_aws as aws
test = aws.lb.LoadBalancer("test",
name="test-lb-tf",
internal=False,
load_balancer_type="application",
security_groups=[lb_sg["id"]],
subnets=[subnet["id"] for subnet in public],
enable_deletion_protection=True,
access_logs={
"bucket": lb_logs["id"],
"prefix": "test-lb",
"enabled": True,
},
tags={
"Environment": "production",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.LB.LoadBalancer("test", new()
{
Name = "test-lb-tf",
Internal = false,
LoadBalancerType = "application",
SecurityGroups = new[]
{
lbSg.Id,
},
Subnets = .Select(subnet =>
{
return subnet.Id;
}).ToList(),
EnableDeletionProtection = true,
AccessLogs = new Aws.LB.Inputs.LoadBalancerAccessLogsArgs
{
Bucket = lbLogs.Id,
Prefix = "test-lb",
Enabled = true,
},
Tags =
{
{ "Environment", "production" },
},
});
});

Network Load Balancer

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.lb.LoadBalancer("test", {
name: "test-lb-tf",
internal: false,
loadBalancerType: "network",
subnets: .map(subnet => (subnet.id)),
enableDeletionProtection: true,
tags: {
Environment: "production",
},
});
import pulumi
import pulumi_aws as aws
test = aws.lb.LoadBalancer("test",
name="test-lb-tf",
internal=False,
load_balancer_type="network",
subnets=[subnet["id"] for subnet in public],
enable_deletion_protection=True,
tags={
"Environment": "production",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.LB.LoadBalancer("test", new()
{
Name = "test-lb-tf",
Internal = false,
LoadBalancerType = "network",
Subnets = .Select(subnet =>
{
return subnet.Id;
}).ToList(),
EnableDeletionProtection = true,
Tags =
{
{ "Environment", "production" },
},
});
});

Specifying Elastic IPs

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lb.LoadBalancer("example", {
name: "example",
loadBalancerType: "network",
subnetMappings: [
{
subnetId: example1AwsSubnet.id,
allocationId: example1.id,
},
{
subnetId: example2AwsSubnet.id,
allocationId: example2.id,
},
],
});
import pulumi
import pulumi_aws as aws
example = aws.lb.LoadBalancer("example",
name="example",
load_balancer_type="network",
subnet_mappings=[
{
"subnet_id": example1_aws_subnet["id"],
"allocation_id": example1["id"],
},
{
"subnet_id": example2_aws_subnet["id"],
"allocation_id": example2["id"],
},
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.LB.LoadBalancer("example", new()
{
Name = "example",
LoadBalancerType = "network",
SubnetMappings = new[]
{
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = example1AwsSubnet.Id,
AllocationId = example1.Id,
},
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = example2AwsSubnet.Id,
AllocationId = example2.Id,
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lb.NewLoadBalancer(ctx, "example", &lb.LoadBalancerArgs{
Name: pulumi.String("example"),
LoadBalancerType: pulumi.String("network"),
SubnetMappings: lb.LoadBalancerSubnetMappingArray{
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(example1AwsSubnet.Id),
AllocationId: pulumi.Any(example1.Id),
},
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(example2AwsSubnet.Id),
AllocationId: pulumi.Any(example2.Id),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.LoadBalancer;
import com.pulumi.aws.lb.LoadBalancerArgs;
import com.pulumi.aws.lb.inputs.LoadBalancerSubnetMappingArgs;
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 example = new LoadBalancer("example", LoadBalancerArgs.builder()
.name("example")
.loadBalancerType("network")
.subnetMappings(
LoadBalancerSubnetMappingArgs.builder()
.subnetId(example1AwsSubnet.id())
.allocationId(example1.id())
.build(),
LoadBalancerSubnetMappingArgs.builder()
.subnetId(example2AwsSubnet.id())
.allocationId(example2.id())
.build())
.build());
}
}
resources:
example:
type: aws:lb:LoadBalancer
properties:
name: example
loadBalancerType: network
subnetMappings:
- subnetId: ${example1AwsSubnet.id}
allocationId: ${example1.id}
- subnetId: ${example2AwsSubnet.id}
allocationId: ${example2.id}

Specifying private IP addresses for an internal-facing load balancer

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lb.LoadBalancer("example", {
name: "example",
loadBalancerType: "network",
subnetMappings: [
{
subnetId: example1.id,
privateIpv4Address: "10.0.1.15",
},
{
subnetId: example2.id,
privateIpv4Address: "10.0.2.15",
},
],
});
import pulumi
import pulumi_aws as aws
example = aws.lb.LoadBalancer("example",
name="example",
load_balancer_type="network",
subnet_mappings=[
{
"subnet_id": example1["id"],
"private_ipv4_address": "10.0.1.15",
},
{
"subnet_id": example2["id"],
"private_ipv4_address": "10.0.2.15",
},
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.LB.LoadBalancer("example", new()
{
Name = "example",
LoadBalancerType = "network",
SubnetMappings = new[]
{
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = example1.Id,
PrivateIpv4Address = "10.0.1.15",
},
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = example2.Id,
PrivateIpv4Address = "10.0.2.15",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lb.NewLoadBalancer(ctx, "example", &lb.LoadBalancerArgs{
Name: pulumi.String("example"),
LoadBalancerType: pulumi.String("network"),
SubnetMappings: lb.LoadBalancerSubnetMappingArray{
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(example1.Id),
PrivateIpv4Address: pulumi.String("10.0.1.15"),
},
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(example2.Id),
PrivateIpv4Address: pulumi.String("10.0.2.15"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.LoadBalancer;
import com.pulumi.aws.lb.LoadBalancerArgs;
import com.pulumi.aws.lb.inputs.LoadBalancerSubnetMappingArgs;
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 example = new LoadBalancer("example", LoadBalancerArgs.builder()
.name("example")
.loadBalancerType("network")
.subnetMappings(
LoadBalancerSubnetMappingArgs.builder()
.subnetId(example1.id())
.privateIpv4Address("10.0.1.15")
.build(),
LoadBalancerSubnetMappingArgs.builder()
.subnetId(example2.id())
.privateIpv4Address("10.0.2.15")
.build())
.build());
}
}
resources:
example:
type: aws:lb:LoadBalancer
properties:
name: example
loadBalancerType: network
subnetMappings:
- subnetId: ${example1.id}
privateIpv4Address: 10.0.1.15
- subnetId: ${example2.id}
privateIpv4Address: 10.0.2.15

Import

Using pulumi import, import LBs using their ARN. For example:

$ pulumi import aws:lb/loadBalancer:LoadBalancer bar arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188

Constructors

Link copied to clipboard
constructor(accessLogs: Output<LoadBalancerAccessLogsArgs>? = null, clientKeepAlive: Output<Int>? = null, connectionLogs: Output<LoadBalancerConnectionLogsArgs>? = null, customerOwnedIpv4Pool: Output<String>? = null, desyncMitigationMode: Output<String>? = null, dnsRecordClientRoutingPolicy: Output<String>? = null, dropInvalidHeaderFields: Output<Boolean>? = null, enableCrossZoneLoadBalancing: Output<Boolean>? = null, enableDeletionProtection: Output<Boolean>? = null, enableHttp2: Output<Boolean>? = null, enableTlsVersionAndCipherSuiteHeaders: Output<Boolean>? = null, enableWafFailOpen: Output<Boolean>? = null, enableXffClientPort: Output<Boolean>? = null, enableZonalShift: Output<Boolean>? = null, enforceSecurityGroupInboundRulesOnPrivateLinkTraffic: Output<String>? = null, idleTimeout: Output<Int>? = null, internal: Output<Boolean>? = null, ipAddressType: Output<String>? = null, ipamPools: Output<LoadBalancerIpamPoolsArgs>? = null, loadBalancerType: Output<String>? = null, name: Output<String>? = null, namePrefix: Output<String>? = null, preserveHostHeader: Output<Boolean>? = null, securityGroups: Output<List<String>>? = null, subnetMappings: Output<List<LoadBalancerSubnetMappingArgs>>? = null, subnets: Output<List<String>>? = null, tags: Output<Map<String, String>>? = null, xffHeaderProcessingMode: Output<String>? = null)

Properties

Link copied to clipboard

Access Logs block. See below.

Link copied to clipboard
val clientKeepAlive: Output<Int>? = null

Client keep alive value in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.

Link copied to clipboard

Connection Logs block. See below. Only valid for Load Balancers of type application.

Link copied to clipboard
val customerOwnedIpv4Pool: Output<String>? = null

ID of the customer owned ipv4 pool to use for this load balancer.

Link copied to clipboard
val desyncMitigationMode: Output<String>? = null

How the load balancer handles requests that might pose a security risk to an application due to HTTP desync. Valid values are monitor, defensive (default), strictest.

Link copied to clipboard

How traffic is distributed among the load balancer Availability Zones. Possible values are any_availability_zone (default), availability_zone_affinity, or partial_availability_zone_affinity. See Availability Zone DNS affinity for additional details. Only valid for network type load balancers.

Link copied to clipboard
val dropInvalidHeaderFields: Output<Boolean>? = null

Whether HTTP headers with header fields that are not valid are removed by the load balancer (true) or routed to targets (false). The default is false. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. Only valid for Load Balancers of type application.

Link copied to clipboard

If true, cross-zone load balancing of the load balancer will be enabled. For network and gateway type load balancers, this feature is disabled by default (false). For application load balancer this feature is always enabled (true) and cannot be disabled. Defaults to false.

Link copied to clipboard
val enableDeletionProtection: Output<Boolean>? = null

If true, deletion of the load balancer will be disabled via the AWS API. This will prevent this provider from deleting the load balancer. Defaults to false.

Link copied to clipboard
val enableHttp2: Output<Boolean>? = null

Whether HTTP/2 is enabled in application load balancers. Defaults to true.

Link copied to clipboard

Whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. Only valid for Load Balancers of type application. Defaults to false

Link copied to clipboard
val enableWafFailOpen: Output<Boolean>? = null

Whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. Defaults to false.

Link copied to clipboard
val enableXffClientPort: Output<Boolean>? = null

Whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer in application load balancers. Defaults to false.

Link copied to clipboard
val enableZonalShift: Output<Boolean>? = null

Whether zonal shift is enabled. Defaults to false.

Whether inbound security group rules are enforced for traffic originating from a PrivateLink. Only valid for Load Balancers of type network. The possible values are on and off.

Link copied to clipboard
val idleTimeout: Output<Int>? = null

Time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type application. Default: 60.

Link copied to clipboard
val internal: Output<Boolean>? = null

If true, the LB will be internal. Defaults to false.

Link copied to clipboard
val ipAddressType: Output<String>? = null

Type of IP addresses used by the subnets for your load balancer. The possible values depend upon the load balancer type: ipv4 (all load balancer types), dualstack (all load balancer types), and dualstack-without-public-ipv4 (type application only).

Link copied to clipboard

. The IPAM pools to use with the load balancer. Only valid for Load Balancers of type application. See ipam_pools for more information.

Link copied to clipboard
val loadBalancerType: Output<String>? = null

Type of load balancer to create. Possible values are application, gateway, or network. The default value is application.

Link copied to clipboard
val name: Output<String>? = null

Name of the LB. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. If not specified, this provider will autogenerate a name beginning with tf-lb.

Link copied to clipboard
val namePrefix: Output<String>? = null

Creates a unique name beginning with the specified prefix. Conflicts with name.

Link copied to clipboard
val preserveHostHeader: Output<Boolean>? = null

Whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. Defaults to false.

Link copied to clipboard
val securityGroups: Output<List<String>>? = null

List of security group IDs to assign to the LB. Only valid for Load Balancers of type application or network. For load balancers of type network security groups cannot be added if none are currently present, and cannot all be removed once added. If either of these conditions are met, this will force a recreation of the resource.

Link copied to clipboard

Subnet mapping block. See below. For Load Balancers of type network subnet mappings can only be added.

Link copied to clipboard
val subnets: Output<List<String>>? = null

List of subnet IDs to attach to the LB. For Load Balancers of type network subnets can only be added (see Availability Zones), deleting a subnet for load balancers of type network will force a recreation of the resource.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val xffHeaderProcessingMode: Output<String>? = null

Determines how the load balancer modifies the X-Forwarded-For header in the HTTP request before sending the request to the target. The possible values are append, preserve, and remove. Only valid for Load Balancers of type application. The default is append.

Functions

Link copied to clipboard
open override fun toJava(): LoadBalancerArgs