Try AWS Native preview for resources not in the classic version.
aws.alb.LoadBalancer
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a Load Balancer resource.
Note:
aws.alb.LoadBalancer
is known asaws.lb.LoadBalancer
. The functionality is identical.
Example Usage
Application Load Balancer
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()
{
Internal = false,
LoadBalancerType = "application",
SecurityGroups = new[]
{
aws_security_group.Lb_sg.Id,
},
Subnets = .Select(subnet =>
{
return subnet.Id;
}).ToList(),
EnableDeletionProtection = true,
AccessLogs = new Aws.LB.Inputs.LoadBalancerAccessLogsArgs
{
Bucket = aws_s3_bucket.Lb_logs.Id,
Prefix = "test-lb",
Enabled = true,
},
Tags =
{
{ "Environment", "production" },
},
});
});
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, "test", &lb.LoadBalancerArgs{
Internal: pulumi.Bool(false),
LoadBalancerType: pulumi.String("application"),
SecurityGroups: pulumi.StringArray{
aws_security_group.Lb_sg.Id,
},
Subnets: "TODO: For expression",
EnableDeletionProtection: pulumi.Bool(true),
AccessLogs: &lb.LoadBalancerAccessLogsArgs{
Bucket: pulumi.Any(aws_s3_bucket.Lb_logs.Id),
Prefix: pulumi.String("test-lb"),
Enabled: pulumi.Bool(true),
},
Tags: pulumi.StringMap{
"Environment": pulumi.String("production"),
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws as aws
test = aws.lb.LoadBalancer("test",
internal=False,
load_balancer_type="application",
security_groups=[aws_security_group["lb_sg"]["id"]],
subnets=[subnet["id"] for subnet in aws_subnet["public"]],
enable_deletion_protection=True,
access_logs=aws.lb.LoadBalancerAccessLogsArgs(
bucket=aws_s3_bucket["lb_logs"]["id"],
prefix="test-lb",
enabled=True,
),
tags={
"Environment": "production",
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.lb.LoadBalancer("test", {
internal: false,
loadBalancerType: "application",
securityGroups: [aws_security_group.lb_sg.id],
subnets: .map(subnet => (subnet.id)),
enableDeletionProtection: true,
accessLogs: {
bucket: aws_s3_bucket.lb_logs.id,
prefix: "test-lb",
enabled: true,
},
tags: {
Environment: "production",
},
});
Coming soon!
Network Load Balancer
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()
{
Internal = false,
LoadBalancerType = "network",
Subnets = .Select(subnet =>
{
return subnet.Id;
}).ToList(),
EnableDeletionProtection = true,
Tags =
{
{ "Environment", "production" },
},
});
});
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, "test", &lb.LoadBalancerArgs{
Internal: pulumi.Bool(false),
LoadBalancerType: pulumi.String("network"),
Subnets: "TODO: For expression",
EnableDeletionProtection: pulumi.Bool(true),
Tags: pulumi.StringMap{
"Environment": pulumi.String("production"),
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws as aws
test = aws.lb.LoadBalancer("test",
internal=False,
load_balancer_type="network",
subnets=[subnet["id"] for subnet in aws_subnet["public"]],
enable_deletion_protection=True,
tags={
"Environment": "production",
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.lb.LoadBalancer("test", {
internal: false,
loadBalancerType: "network",
subnets: .map(subnet => (subnet.id)),
enableDeletionProtection: true,
tags: {
Environment: "production",
},
});
Coming soon!
Specifying Elastic IPs
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()
{
LoadBalancerType = "network",
SubnetMappings = new[]
{
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = aws_subnet.Example1.Id,
AllocationId = aws_eip.Example1.Id,
},
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = aws_subnet.Example2.Id,
AllocationId = aws_eip.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{
LoadBalancerType: pulumi.String("network"),
SubnetMappings: lb.LoadBalancerSubnetMappingArray{
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(aws_subnet.Example1.Id),
AllocationId: pulumi.Any(aws_eip.Example1.Id),
},
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(aws_subnet.Example2.Id),
AllocationId: pulumi.Any(aws_eip.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()
.loadBalancerType("network")
.subnetMappings(
LoadBalancerSubnetMappingArgs.builder()
.subnetId(aws_subnet.example1().id())
.allocationId(aws_eip.example1().id())
.build(),
LoadBalancerSubnetMappingArgs.builder()
.subnetId(aws_subnet.example2().id())
.allocationId(aws_eip.example2().id())
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.lb.LoadBalancer("example",
load_balancer_type="network",
subnet_mappings=[
aws.lb.LoadBalancerSubnetMappingArgs(
subnet_id=aws_subnet["example1"]["id"],
allocation_id=aws_eip["example1"]["id"],
),
aws.lb.LoadBalancerSubnetMappingArgs(
subnet_id=aws_subnet["example2"]["id"],
allocation_id=aws_eip["example2"]["id"],
),
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lb.LoadBalancer("example", {
loadBalancerType: "network",
subnetMappings: [
{
subnetId: aws_subnet.example1.id,
allocationId: aws_eip.example1.id,
},
{
subnetId: aws_subnet.example2.id,
allocationId: aws_eip.example2.id,
},
],
});
resources:
example:
type: aws:lb:LoadBalancer
properties:
loadBalancerType: network
subnetMappings:
- subnetId: ${aws_subnet.example1.id}
allocationId: ${aws_eip.example1.id}
- subnetId: ${aws_subnet.example2.id}
allocationId: ${aws_eip.example2.id}
Specifying private IP addresses for an internal-facing load balancer
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()
{
LoadBalancerType = "network",
SubnetMappings = new[]
{
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = aws_subnet.Example1.Id,
PrivateIpv4Address = "10.0.1.15",
},
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = aws_subnet.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{
LoadBalancerType: pulumi.String("network"),
SubnetMappings: lb.LoadBalancerSubnetMappingArray{
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(aws_subnet.Example1.Id),
PrivateIpv4Address: pulumi.String("10.0.1.15"),
},
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.Any(aws_subnet.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()
.loadBalancerType("network")
.subnetMappings(
LoadBalancerSubnetMappingArgs.builder()
.subnetId(aws_subnet.example1().id())
.privateIpv4Address("10.0.1.15")
.build(),
LoadBalancerSubnetMappingArgs.builder()
.subnetId(aws_subnet.example2().id())
.privateIpv4Address("10.0.2.15")
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.lb.LoadBalancer("example",
load_balancer_type="network",
subnet_mappings=[
aws.lb.LoadBalancerSubnetMappingArgs(
subnet_id=aws_subnet["example1"]["id"],
private_ipv4_address="10.0.1.15",
),
aws.lb.LoadBalancerSubnetMappingArgs(
subnet_id=aws_subnet["example2"]["id"],
private_ipv4_address="10.0.2.15",
),
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lb.LoadBalancer("example", {
loadBalancerType: "network",
subnetMappings: [
{
subnetId: aws_subnet.example1.id,
privateIpv4Address: "10.0.1.15",
},
{
subnetId: aws_subnet.example2.id,
privateIpv4Address: "10.0.2.15",
},
],
});
resources:
example:
type: aws:lb:LoadBalancer
properties:
loadBalancerType: network
subnetMappings:
- subnetId: ${aws_subnet.example1.id}
privateIpv4Address: 10.0.1.15
- subnetId: ${aws_subnet.example2.id}
privateIpv4Address: 10.0.2.15
Create LoadBalancer Resource
new LoadBalancer(name: string, args?: LoadBalancerArgs, opts?: CustomResourceOptions);
@overload
def LoadBalancer(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_logs: Optional[LoadBalancerAccessLogsArgs] = None,
customer_owned_ipv4_pool: Optional[str] = None,
desync_mitigation_mode: Optional[str] = None,
drop_invalid_header_fields: Optional[bool] = None,
enable_cross_zone_load_balancing: Optional[bool] = None,
enable_deletion_protection: Optional[bool] = None,
enable_http2: Optional[bool] = None,
enable_tls_version_and_cipher_suite_headers: Optional[bool] = None,
enable_waf_fail_open: Optional[bool] = None,
enable_xff_client_port: Optional[bool] = None,
idle_timeout: Optional[int] = None,
internal: Optional[bool] = None,
ip_address_type: Optional[str] = None,
load_balancer_type: Optional[str] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
preserve_host_header: Optional[bool] = None,
security_groups: Optional[Sequence[str]] = None,
subnet_mappings: Optional[Sequence[LoadBalancerSubnetMappingArgs]] = None,
subnets: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
xff_header_processing_mode: Optional[str] = None)
@overload
def LoadBalancer(resource_name: str,
args: Optional[LoadBalancerArgs] = None,
opts: Optional[ResourceOptions] = 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: aws:alb:LoadBalancer
properties: # The arguments to resource properties.
options: # 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.
- 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.
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
The LoadBalancer resource accepts the following input properties:
- Access
Logs LoadBalancer Access Logs An Access Logs block. Access Logs documented below.
- Customer
Owned stringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- Desync
Mitigation stringMode Determines 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
.- Drop
Invalid boolHeader Fields Indicates 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
.- Enable
Cross boolZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- Enable
Deletion boolProtection 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
.- Enable
Http2 bool Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- Enable
Tls boolVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- Enable
Waf boolFail Open Indicates 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
.- Enable
Xff boolClient Port Indicates 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 tofalse
.- Idle
Timeout int The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- Internal bool
If true, the LB will be internal. Defaults to
false
.- Ip
Address stringType The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- Load
Balancer stringType The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- Name string
The 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
.- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
.- Preserve
Host boolHeader Indicates 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
.- Security
Groups List<string> A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- Subnet
Mappings List<LoadBalancer Subnet Mapping> A subnet mapping block as documented below.
- Subnets List<string>
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Dictionary<string, string>
A 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.- Xff
Header stringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.
- Access
Logs LoadBalancer Access Logs Args An Access Logs block. Access Logs documented below.
- Customer
Owned stringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- Desync
Mitigation stringMode Determines 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
.- Drop
Invalid boolHeader Fields Indicates 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
.- Enable
Cross boolZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- Enable
Deletion boolProtection 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
.- Enable
Http2 bool Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- Enable
Tls boolVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- Enable
Waf boolFail Open Indicates 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
.- Enable
Xff boolClient Port Indicates 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 tofalse
.- Idle
Timeout int The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- Internal bool
If true, the LB will be internal. Defaults to
false
.- Ip
Address stringType The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- Load
Balancer stringType The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- Name string
The 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
.- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
.- Preserve
Host boolHeader Indicates 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
.- Security
Groups []string A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- Subnet
Mappings []LoadBalancer Subnet Mapping Args A subnet mapping block as documented below.
- Subnets []string
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- map[string]string
A 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.- Xff
Header stringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.
- access
Logs LoadBalancer Access Logs An Access Logs block. Access Logs documented below.
- customer
Owned StringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync
Mitigation StringMode Determines 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
.- drop
Invalid BooleanHeader Fields Indicates 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
.- enable
Cross BooleanZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable
Deletion BooleanProtection 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
.- enable
Http2 Boolean Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable
Tls BooleanVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable
Waf BooleanFail Open Indicates 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
.- enable
Xff BooleanClient Port Indicates 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 tofalse
.- idle
Timeout Integer The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal Boolean
If true, the LB will be internal. Defaults to
false
.- ip
Address StringType The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load
Balancer StringType The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name String
The 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
.- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve
Host BooleanHeader Indicates 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
.- security
Groups List<String> A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet
Mappings List<LoadBalancer Subnet Mapping> A subnet mapping block as documented below.
- subnets List<String>
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Map<String,String>
A 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.- xff
Header StringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.
- access
Logs LoadBalancer Access Logs An Access Logs block. Access Logs documented below.
- customer
Owned stringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync
Mitigation stringMode Determines 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
.- drop
Invalid booleanHeader Fields Indicates 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
.- enable
Cross booleanZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable
Deletion booleanProtection 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
.- enable
Http2 boolean Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable
Tls booleanVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable
Waf booleanFail Open Indicates 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
.- enable
Xff booleanClient Port Indicates 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 tofalse
.- idle
Timeout number The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal boolean
If true, the LB will be internal. Defaults to
false
.- ip
Address IpType Address Type The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load
Balancer LoadType Balancer Type The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name string
The 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
.- name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve
Host booleanHeader Indicates 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
.- security
Groups string[] A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet
Mappings LoadBalancer Subnet Mapping[] A subnet mapping block as documented below.
- subnets string[]
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- {[key: string]: string}
A 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.- xff
Header stringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.
- access_
logs LoadBalancer Access Logs Args An Access Logs block. Access Logs documented below.
- customer_
owned_ stripv4_ pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync_
mitigation_ strmode Determines 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
.- drop_
invalid_ boolheader_ fields Indicates 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
.- enable_
cross_ boolzone_ load_ balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable_
deletion_ boolprotection 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
.- enable_
http2 bool Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable_
tls_ boolversion_ and_ cipher_ suite_ headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable_
waf_ boolfail_ open Indicates 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
.- enable_
xff_ boolclient_ port Indicates 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 tofalse
.- idle_
timeout int The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal bool
If true, the LB will be internal. Defaults to
false
.- ip_
address_ strtype The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load_
balancer_ strtype The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name str
The 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
.- name_
prefix str Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve_
host_ boolheader Indicates 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
.- security_
groups Sequence[str] A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet_
mappings Sequence[LoadBalancer Subnet Mapping Args] A subnet mapping block as documented below.
- subnets Sequence[str]
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Mapping[str, str]
A 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.- xff_
header_ strprocessing_ mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.
- access
Logs Property Map An Access Logs block. Access Logs documented below.
- customer
Owned StringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync
Mitigation StringMode Determines 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
.- drop
Invalid BooleanHeader Fields Indicates 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
.- enable
Cross BooleanZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable
Deletion BooleanProtection 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
.- enable
Http2 Boolean Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable
Tls BooleanVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable
Waf BooleanFail Open Indicates 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
.- enable
Xff BooleanClient Port Indicates 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 tofalse
.- idle
Timeout Number The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal Boolean
If true, the LB will be internal. Defaults to
false
.- ip
Address Type The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load
Balancer Type The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name String
The 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
.- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve
Host BooleanHeader Indicates 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
.- security
Groups List<String> A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet
Mappings List<Property Map> A subnet mapping block as documented below.
- subnets List<String>
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Map<String>
A 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.- xff
Header StringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.
Outputs
All input properties are implicitly available as output properties. Additionally, the LoadBalancer resource produces the following output properties:
- Arn string
The ARN of the load balancer (matches
id
).- Arn
Suffix string The ARN suffix for use with CloudWatch Metrics.
- Dns
Name string The DNS name of the load balancer.
- Id string
The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Vpc
Id string - Zone
Id string The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- Arn string
The ARN of the load balancer (matches
id
).- Arn
Suffix string The ARN suffix for use with CloudWatch Metrics.
- Dns
Name string The DNS name of the load balancer.
- Id string
The provider-assigned unique ID for this managed resource.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Vpc
Id string - Zone
Id string The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- arn String
The ARN of the load balancer (matches
id
).- arn
Suffix String The ARN suffix for use with CloudWatch Metrics.
- dns
Name String The DNS name of the load balancer.
- id String
The provider-assigned unique ID for this managed resource.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Id String - zone
Id String The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- arn string
The ARN of the load balancer (matches
id
).- arn
Suffix string The ARN suffix for use with CloudWatch Metrics.
- dns
Name string The DNS name of the load balancer.
- id string
The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Id string - zone
Id string The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- arn str
The ARN of the load balancer (matches
id
).- arn_
suffix str The ARN suffix for use with CloudWatch Metrics.
- dns_
name str The DNS name of the load balancer.
- id str
The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc_
id str - zone_
id str The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- arn String
The ARN of the load balancer (matches
id
).- arn
Suffix String The ARN suffix for use with CloudWatch Metrics.
- dns
Name String The DNS name of the load balancer.
- id String
The provider-assigned unique ID for this managed resource.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Id String - zone
Id String The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
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,
access_logs: Optional[LoadBalancerAccessLogsArgs] = None,
arn: Optional[str] = None,
arn_suffix: Optional[str] = None,
customer_owned_ipv4_pool: Optional[str] = None,
desync_mitigation_mode: Optional[str] = None,
dns_name: Optional[str] = None,
drop_invalid_header_fields: Optional[bool] = None,
enable_cross_zone_load_balancing: Optional[bool] = None,
enable_deletion_protection: Optional[bool] = None,
enable_http2: Optional[bool] = None,
enable_tls_version_and_cipher_suite_headers: Optional[bool] = None,
enable_waf_fail_open: Optional[bool] = None,
enable_xff_client_port: Optional[bool] = None,
idle_timeout: Optional[int] = None,
internal: Optional[bool] = None,
ip_address_type: Optional[str] = None,
load_balancer_type: Optional[str] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
preserve_host_header: Optional[bool] = None,
security_groups: Optional[Sequence[str]] = None,
subnet_mappings: Optional[Sequence[LoadBalancerSubnetMappingArgs]] = None,
subnets: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
vpc_id: Optional[str] = None,
xff_header_processing_mode: Optional[str] = None,
zone_id: 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.
- Access
Logs LoadBalancer Access Logs An Access Logs block. Access Logs documented below.
- Arn string
The ARN of the load balancer (matches
id
).- Arn
Suffix string The ARN suffix for use with CloudWatch Metrics.
- Customer
Owned stringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- Desync
Mitigation stringMode Determines 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
.- Dns
Name string The DNS name of the load balancer.
- Drop
Invalid boolHeader Fields Indicates 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
.- Enable
Cross boolZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- Enable
Deletion boolProtection 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
.- Enable
Http2 bool Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- Enable
Tls boolVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- Enable
Waf boolFail Open Indicates 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
.- Enable
Xff boolClient Port Indicates 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 tofalse
.- Idle
Timeout int The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- Internal bool
If true, the LB will be internal. Defaults to
false
.- Ip
Address stringType The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- Load
Balancer stringType The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- Name string
The 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
.- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
.- Preserve
Host boolHeader Indicates 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
.- Security
Groups List<string> A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- Subnet
Mappings List<LoadBalancer Subnet Mapping> A subnet mapping block as documented below.
- Subnets List<string>
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Dictionary<string, string>
A 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Vpc
Id string - Xff
Header stringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.- Zone
Id string The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- Access
Logs LoadBalancer Access Logs Args An Access Logs block. Access Logs documented below.
- Arn string
The ARN of the load balancer (matches
id
).- Arn
Suffix string The ARN suffix for use with CloudWatch Metrics.
- Customer
Owned stringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- Desync
Mitigation stringMode Determines 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
.- Dns
Name string The DNS name of the load balancer.
- Drop
Invalid boolHeader Fields Indicates 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
.- Enable
Cross boolZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- Enable
Deletion boolProtection 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
.- Enable
Http2 bool Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- Enable
Tls boolVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- Enable
Waf boolFail Open Indicates 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
.- Enable
Xff boolClient Port Indicates 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 tofalse
.- Idle
Timeout int The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- Internal bool
If true, the LB will be internal. Defaults to
false
.- Ip
Address stringType The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- Load
Balancer stringType The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- Name string
The 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
.- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
.- Preserve
Host boolHeader Indicates 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
.- Security
Groups []string A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- Subnet
Mappings []LoadBalancer Subnet Mapping Args A subnet mapping block as documented below.
- Subnets []string
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- map[string]string
A 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Vpc
Id string - Xff
Header stringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.- Zone
Id string The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- access
Logs LoadBalancer Access Logs An Access Logs block. Access Logs documented below.
- arn String
The ARN of the load balancer (matches
id
).- arn
Suffix String The ARN suffix for use with CloudWatch Metrics.
- customer
Owned StringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync
Mitigation StringMode Determines 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
.- dns
Name String The DNS name of the load balancer.
- drop
Invalid BooleanHeader Fields Indicates 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
.- enable
Cross BooleanZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable
Deletion BooleanProtection 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
.- enable
Http2 Boolean Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable
Tls BooleanVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable
Waf BooleanFail Open Indicates 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
.- enable
Xff BooleanClient Port Indicates 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 tofalse
.- idle
Timeout Integer The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal Boolean
If true, the LB will be internal. Defaults to
false
.- ip
Address StringType The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load
Balancer StringType The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name String
The 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
.- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve
Host BooleanHeader Indicates 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
.- security
Groups List<String> A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet
Mappings List<LoadBalancer Subnet Mapping> A subnet mapping block as documented below.
- subnets List<String>
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Map<String,String>
A 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Id String - xff
Header StringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.- zone
Id String The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- access
Logs LoadBalancer Access Logs An Access Logs block. Access Logs documented below.
- arn string
The ARN of the load balancer (matches
id
).- arn
Suffix string The ARN suffix for use with CloudWatch Metrics.
- customer
Owned stringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync
Mitigation stringMode Determines 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
.- dns
Name string The DNS name of the load balancer.
- drop
Invalid booleanHeader Fields Indicates 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
.- enable
Cross booleanZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable
Deletion booleanProtection 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
.- enable
Http2 boolean Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable
Tls booleanVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable
Waf booleanFail Open Indicates 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
.- enable
Xff booleanClient Port Indicates 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 tofalse
.- idle
Timeout number The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal boolean
If true, the LB will be internal. Defaults to
false
.- ip
Address IpType Address Type The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load
Balancer LoadType Balancer Type The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name string
The 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
.- name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve
Host booleanHeader Indicates 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
.- security
Groups string[] A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet
Mappings LoadBalancer Subnet Mapping[] A subnet mapping block as documented below.
- subnets string[]
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- {[key: string]: string}
A 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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Id string - xff
Header stringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.- zone
Id string The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- access_
logs LoadBalancer Access Logs Args An Access Logs block. Access Logs documented below.
- arn str
The ARN of the load balancer (matches
id
).- arn_
suffix str The ARN suffix for use with CloudWatch Metrics.
- customer_
owned_ stripv4_ pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync_
mitigation_ strmode Determines 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
.- dns_
name str The DNS name of the load balancer.
- drop_
invalid_ boolheader_ fields Indicates 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
.- enable_
cross_ boolzone_ load_ balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable_
deletion_ boolprotection 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
.- enable_
http2 bool Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable_
tls_ boolversion_ and_ cipher_ suite_ headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable_
waf_ boolfail_ open Indicates 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
.- enable_
xff_ boolclient_ port Indicates 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 tofalse
.- idle_
timeout int The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal bool
If true, the LB will be internal. Defaults to
false
.- ip_
address_ strtype The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load_
balancer_ strtype The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name str
The 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
.- name_
prefix str Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve_
host_ boolheader Indicates 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
.- security_
groups Sequence[str] A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet_
mappings Sequence[LoadBalancer Subnet Mapping Args] A subnet mapping block as documented below.
- subnets Sequence[str]
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Mapping[str, str]
A 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc_
id str - xff_
header_ strprocessing_ mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.- zone_
id str The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
- access
Logs Property Map An Access Logs block. Access Logs documented below.
- arn String
The ARN of the load balancer (matches
id
).- arn
Suffix String The ARN suffix for use with CloudWatch Metrics.
- customer
Owned StringIpv4Pool The ID of the customer owned ipv4 pool to use for this load balancer.
- desync
Mitigation StringMode Determines 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
.- dns
Name String The DNS name of the load balancer.
- drop
Invalid BooleanHeader Fields Indicates 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
.- enable
Cross BooleanZone Load Balancing If true, cross-zone load balancing of the load balancer will be enabled. For
network
andgateway
type load balancers, this feature is disabled by default (false
). Forapplication
load balancer this feature is always enabled (true
) and cannot be disabled. Defaults tofalse
.- enable
Deletion BooleanProtection 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
.- enable
Http2 Boolean Indicates whether HTTP/2 is enabled in
application
load balancers. Defaults totrue
.- enable
Tls BooleanVersion And Cipher Suite Headers Indicates whether the two headers (
x-amzn-tls-version
andx-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 typeapplication
. Defaults tofalse
- enable
Waf BooleanFail Open Indicates 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
.- enable
Xff BooleanClient Port Indicates 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 tofalse
.- idle
Timeout Number The time in seconds that the connection is allowed to be idle. Only valid for Load Balancers of type
application
. Default: 60.- internal Boolean
If true, the LB will be internal. Defaults to
false
.- ip
Address Type The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
anddualstack
.- load
Balancer Type The type of load balancer to create. Possible values are
application
,gateway
, ornetwork
. The default value isapplication
.- name String
The 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
.- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
.- preserve
Host BooleanHeader Indicates 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
.- security
Groups List<String> A list of security group IDs to assign to the LB. Only valid for Load Balancers of type
application
ornetwork
. For load balancers of typenetwork
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.- subnet
Mappings List<Property Map> A subnet mapping block as documented below.
- subnets List<String>
A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type
network
. Changing this value for load balancers of typenetwork
will force a recreation of the resource.- Map<String>
A 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Id String - xff
Header StringProcessing Mode 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 areappend
,preserve
, andremove
. Only valid for Load Balancers of typeapplication
. The default isappend
.- zone
Id String The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record).
Supporting Types
LoadBalancerAccessLogs, LoadBalancerAccessLogsArgs
LoadBalancerSubnetMapping, LoadBalancerSubnetMappingArgs
- Subnet
Id string ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.
- Allocation
Id string The allocation ID of the Elastic IP address for an internet-facing load balancer.
- Ipv6Address string
The IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.
- Outpost
Id string - Private
Ipv4Address string The private IPv4 address for an internal load balancer.
- Subnet
Id string ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.
- Allocation
Id string The allocation ID of the Elastic IP address for an internet-facing load balancer.
- Ipv6Address string
The IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.
- Outpost
Id string - Private
Ipv4Address string The private IPv4 address for an internal load balancer.
- subnet
Id String ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.
- allocation
Id String The allocation ID of the Elastic IP address for an internet-facing load balancer.
- ipv6Address String
The IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.
- outpost
Id String - private
Ipv4Address String The private IPv4 address for an internal load balancer.
- subnet
Id string ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.
- allocation
Id string The allocation ID of the Elastic IP address for an internet-facing load balancer.
- ipv6Address string
The IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.
- outpost
Id string - private
Ipv4Address string The private IPv4 address for an internal load balancer.
- subnet_
id str ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.
- allocation_
id str The allocation ID of the Elastic IP address for an internet-facing load balancer.
- ipv6_
address str The IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.
- outpost_
id str - private_
ipv4_ straddress The private IPv4 address for an internal load balancer.
- subnet
Id String ID of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone.
- allocation
Id String The allocation ID of the Elastic IP address for an internet-facing load balancer.
- ipv6Address String
The IPv6 address. You associate IPv6 CIDR blocks with your VPC and choose the subnets where you launch both internet-facing and internal Application Load Balancers or Network Load Balancers.
- outpost
Id String - private
Ipv4Address String The private IPv4 address for an internal load balancer.
Import
Using pulumi import
, import LBs using their ARN. For example:
$ pulumi import aws:alb/loadBalancer:LoadBalancer bar arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.