We recommend new projects start with resources from the AWS provider.
published on Monday, Apr 20, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Apr 20, 2026 by Pulumi
Resource Type definition for AWS::ElasticLoadBalancing::LoadBalancer
Using getLoadBalancer
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getLoadBalancer(args: GetLoadBalancerArgs, opts?: InvokeOptions): Promise<GetLoadBalancerResult>
function getLoadBalancerOutput(args: GetLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerResult>def get_load_balancer(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
def get_load_balancer_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerResult]func LookupLoadBalancer(ctx *Context, args *LookupLoadBalancerArgs, opts ...InvokeOption) (*LookupLoadBalancerResult, error)
func LookupLoadBalancerOutput(ctx *Context, args *LookupLoadBalancerOutputArgs, opts ...InvokeOption) LookupLoadBalancerResultOutput> Note: This function is named LookupLoadBalancer in the Go SDK.
public static class GetLoadBalancer
{
public static Task<GetLoadBalancerResult> InvokeAsync(GetLoadBalancerArgs args, InvokeOptions? opts = null)
public static Output<GetLoadBalancerResult> Invoke(GetLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)
public static Output<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:elasticloadbalancing:getLoadBalancer
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- Id string
- id String
- id string
- id str
- id String
getLoadBalancer Result
The following output properties are available:
- Access
Logging Pulumi.Policy Aws Native. Elastic Load Balancing. Outputs. Load Balancer Access Logging Policy - Information about where and how access logs are stored for the load balancer.
-
List<Pulumi.
Aws Native. Elastic Load Balancing. Outputs. Load Balancer App Cookie Stickiness Policy> - Information about a policy for application-controlled session stickiness.
- Availability
Zones List<string> The Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify
Subnetsinstead.Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.
- Canonical
Hosted stringZone Name - The name of the Route 53 hosted zone that is associated with the load balancer. Internal-facing load balancers don't use this value, use
DNSNameinstead. - Canonical
Hosted stringZone Name Id - The ID of the Route 53 hosted zone name that is associated with the load balancer.
- Connection
Draining Pulumi.Policy Aws Native. Elastic Load Balancing. Outputs. Load Balancer Connection Draining Policy If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure connection draining in the User Guide for Classic Load Balancers .
- Connection
Settings Pulumi.Aws Native. Elastic Load Balancing. Outputs. Load Balancer Connection Settings If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure idle connection timeout in the User Guide for Classic Load Balancers .
- Cross
Zone bool If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure cross-zone load balancing in the User Guide for Classic Load Balancers .
- Dns
Name string - The DNS name for the load balancer.
- Health
Check Pulumi.Aws Native. Elastic Load Balancing. Outputs. Load Balancer Health Check The health check settings to use when evaluating the health of your EC2 instances.
Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.
- Id string
- Instances List<string>
- The IDs of the instances for the load balancer.
-
List<Pulumi.
Aws Native. Elastic Load Balancing. Outputs. Load Balancer Lb Cookie Stickiness Policy> - Information about a policy for duration-based session stickiness.
- Listeners
List<Pulumi.
Aws Native. Elastic Load Balancing. Outputs. Load Balancer Listeners> The listeners for the load balancer. You can specify at most one listener per port.
If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.
- Policies
List<Pulumi.
Aws Native. Elastic Load Balancing. Outputs. Load Balancer Policies> - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- Security
Groups List<string> - The security groups for the load balancer. Valid only for load balancers in a VPC.
- Source
Security stringGroup Group Name - Source
Security stringGroup Owner Alias - Subnets List<string>
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.
-
List<Pulumi.
Aws Native. Outputs. Tag> - The tags associated with a load balancer.
- Access
Logging LoadPolicy Balancer Access Logging Policy - Information about where and how access logs are stored for the load balancer.
-
[]Load
Balancer App Cookie Stickiness Policy - Information about a policy for application-controlled session stickiness.
- Availability
Zones []string The Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify
Subnetsinstead.Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.
- Canonical
Hosted stringZone Name - The name of the Route 53 hosted zone that is associated with the load balancer. Internal-facing load balancers don't use this value, use
DNSNameinstead. - Canonical
Hosted stringZone Name Id - The ID of the Route 53 hosted zone name that is associated with the load balancer.
- Connection
Draining LoadPolicy Balancer Connection Draining Policy If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure connection draining in the User Guide for Classic Load Balancers .
- Connection
Settings LoadBalancer Connection Settings If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure idle connection timeout in the User Guide for Classic Load Balancers .
- Cross
Zone bool If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure cross-zone load balancing in the User Guide for Classic Load Balancers .
- Dns
Name string - The DNS name for the load balancer.
- Health
Check LoadBalancer Health Check The health check settings to use when evaluating the health of your EC2 instances.
Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.
- Id string
- Instances []string
- The IDs of the instances for the load balancer.
-
[]Load
Balancer Lb Cookie Stickiness Policy - Information about a policy for duration-based session stickiness.
- Listeners
[]Load
Balancer Listeners The listeners for the load balancer. You can specify at most one listener per port.
If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.
- Policies
[]Load
Balancer Policies - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- Security
Groups []string - The security groups for the load balancer. Valid only for load balancers in a VPC.
- Source
Security stringGroup Group Name - Source
Security stringGroup Owner Alias - Subnets []string
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.
- Tag
- The tags associated with a load balancer.
- access
Logging LoadPolicy Balancer Access Logging Policy - Information about where and how access logs are stored for the load balancer.
-
List<Load
Balancer App Cookie Stickiness Policy> - Information about a policy for application-controlled session stickiness.
- availability
Zones List<String> The Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify
Subnetsinstead.Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.
- canonical
Hosted StringZone Name - The name of the Route 53 hosted zone that is associated with the load balancer. Internal-facing load balancers don't use this value, use
DNSNameinstead. - canonical
Hosted StringZone Name Id - The ID of the Route 53 hosted zone name that is associated with the load balancer.
- connection
Draining LoadPolicy Balancer Connection Draining Policy If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure connection draining in the User Guide for Classic Load Balancers .
- connection
Settings LoadBalancer Connection Settings If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure idle connection timeout in the User Guide for Classic Load Balancers .
- cross
Zone Boolean If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure cross-zone load balancing in the User Guide for Classic Load Balancers .
- dns
Name String - The DNS name for the load balancer.
- health
Check LoadBalancer Health Check The health check settings to use when evaluating the health of your EC2 instances.
Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.
- id String
- instances List<String>
- The IDs of the instances for the load balancer.
-
List<Load
Balancer Lb Cookie Stickiness Policy> - Information about a policy for duration-based session stickiness.
- listeners
List<Load
Balancer Listeners> The listeners for the load balancer. You can specify at most one listener per port.
If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.
- policies
List<Load
Balancer Policies> - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- security
Groups List<String> - The security groups for the load balancer. Valid only for load balancers in a VPC.
- source
Security StringGroup Group Name - source
Security StringGroup Owner Alias - subnets List<String>
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.
- List<Tag>
- The tags associated with a load balancer.
- access
Logging LoadPolicy Balancer Access Logging Policy - Information about where and how access logs are stored for the load balancer.
-
Load
Balancer App Cookie Stickiness Policy[] - Information about a policy for application-controlled session stickiness.
- availability
Zones string[] The Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify
Subnetsinstead.Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.
- canonical
Hosted stringZone Name - The name of the Route 53 hosted zone that is associated with the load balancer. Internal-facing load balancers don't use this value, use
DNSNameinstead. - canonical
Hosted stringZone Name Id - The ID of the Route 53 hosted zone name that is associated with the load balancer.
- connection
Draining LoadPolicy Balancer Connection Draining Policy If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure connection draining in the User Guide for Classic Load Balancers .
- connection
Settings LoadBalancer Connection Settings If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure idle connection timeout in the User Guide for Classic Load Balancers .
- cross
Zone boolean If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure cross-zone load balancing in the User Guide for Classic Load Balancers .
- dns
Name string - The DNS name for the load balancer.
- health
Check LoadBalancer Health Check The health check settings to use when evaluating the health of your EC2 instances.
Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.
- id string
- instances string[]
- The IDs of the instances for the load balancer.
-
Load
Balancer Lb Cookie Stickiness Policy[] - Information about a policy for duration-based session stickiness.
- listeners
Load
Balancer Listeners[] The listeners for the load balancer. You can specify at most one listener per port.
If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.
- policies
Load
Balancer Policies[] - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- security
Groups string[] - The security groups for the load balancer. Valid only for load balancers in a VPC.
- source
Security stringGroup Group Name - source
Security stringGroup Owner Alias - subnets string[]
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.
- Tag[]
- The tags associated with a load balancer.
- access_
logging_ Loadpolicy Balancer Access Logging Policy - Information about where and how access logs are stored for the load balancer.
-
Sequence[Load
Balancer App Cookie Stickiness Policy] - Information about a policy for application-controlled session stickiness.
- availability_
zones Sequence[str] The Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify
Subnetsinstead.Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.
- canonical_
hosted_ strzone_ name - The name of the Route 53 hosted zone that is associated with the load balancer. Internal-facing load balancers don't use this value, use
DNSNameinstead. - canonical_
hosted_ strzone_ name_ id - The ID of the Route 53 hosted zone name that is associated with the load balancer.
- connection_
draining_ Loadpolicy Balancer Connection Draining Policy If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure connection draining in the User Guide for Classic Load Balancers .
- connection_
settings LoadBalancer Connection Settings If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure idle connection timeout in the User Guide for Classic Load Balancers .
- cross_
zone bool If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure cross-zone load balancing in the User Guide for Classic Load Balancers .
- dns_
name str - The DNS name for the load balancer.
- health_
check LoadBalancer Health Check The health check settings to use when evaluating the health of your EC2 instances.
Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.
- id str
- instances Sequence[str]
- The IDs of the instances for the load balancer.
-
Sequence[Load
Balancer Lb Cookie Stickiness Policy] - Information about a policy for duration-based session stickiness.
- listeners
Sequence[Load
Balancer Listeners] The listeners for the load balancer. You can specify at most one listener per port.
If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.
- policies
Sequence[Load
Balancer Policies] - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- security_
groups Sequence[str] - The security groups for the load balancer. Valid only for load balancers in a VPC.
- source_
security_ strgroup_ group_ name - source_
security_ strgroup_ owner_ alias - subnets Sequence[str]
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.
- Sequence[root_Tag]
- The tags associated with a load balancer.
- access
Logging Property MapPolicy - Information about where and how access logs are stored for the load balancer.
- List<Property Map>
- Information about a policy for application-controlled session stickiness.
- availability
Zones List<String> The Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify
Subnetsinstead.Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.
- canonical
Hosted StringZone Name - The name of the Route 53 hosted zone that is associated with the load balancer. Internal-facing load balancers don't use this value, use
DNSNameinstead. - canonical
Hosted StringZone Name Id - The ID of the Route 53 hosted zone name that is associated with the load balancer.
- connection
Draining Property MapPolicy If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure connection draining in the User Guide for Classic Load Balancers .
- connection
Settings Property Map If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure idle connection timeout in the User Guide for Classic Load Balancers .
- cross
Zone Boolean If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure cross-zone load balancing in the User Guide for Classic Load Balancers .
- dns
Name String - The DNS name for the load balancer.
- health
Check Property Map The health check settings to use when evaluating the health of your EC2 instances.
Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.
- id String
- instances List<String>
- The IDs of the instances for the load balancer.
- List<Property Map>
- Information about a policy for duration-based session stickiness.
- listeners List<Property Map>
The listeners for the load balancer. You can specify at most one listener per port.
If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.
- policies List<Property Map>
- The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- security
Groups List<String> - The security groups for the load balancer. Valid only for load balancers in a VPC.
- source
Security StringGroup Group Name - source
Security StringGroup Owner Alias - subnets List<String>
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.
- List<Property Map>
- The tags associated with a load balancer.
Supporting Types
LoadBalancerAccessLoggingPolicy
- Enabled bool
- Specifies whether access logs are enabled for the load balancer.
- S3Bucket
Name string - The name of the Amazon S3 bucket where the access logs are stored.
- Emit
Interval int The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
- S3Bucket
Prefix string - The logical hierarchy you created for your Amazon S3 bucket, for example
my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
- Enabled bool
- Specifies whether access logs are enabled for the load balancer.
- S3Bucket
Name string - The name of the Amazon S3 bucket where the access logs are stored.
- Emit
Interval int The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
- S3Bucket
Prefix string - The logical hierarchy you created for your Amazon S3 bucket, for example
my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
- enabled Boolean
- Specifies whether access logs are enabled for the load balancer.
- s3Bucket
Name String - The name of the Amazon S3 bucket where the access logs are stored.
- emit
Interval Integer The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
- s3Bucket
Prefix String - The logical hierarchy you created for your Amazon S3 bucket, for example
my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
- enabled boolean
- Specifies whether access logs are enabled for the load balancer.
- s3Bucket
Name string - The name of the Amazon S3 bucket where the access logs are stored.
- emit
Interval number The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
- s3Bucket
Prefix string - The logical hierarchy you created for your Amazon S3 bucket, for example
my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
- enabled bool
- Specifies whether access logs are enabled for the load balancer.
- s3_
bucket_ strname - The name of the Amazon S3 bucket where the access logs are stored.
- emit_
interval int The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
- s3_
bucket_ strprefix - The logical hierarchy you created for your Amazon S3 bucket, for example
my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
- enabled Boolean
- Specifies whether access logs are enabled for the load balancer.
- s3Bucket
Name String - The name of the Amazon S3 bucket where the access logs are stored.
- emit
Interval Number The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
- s3Bucket
Prefix String - The logical hierarchy you created for your Amazon S3 bucket, for example
my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
LoadBalancerAppCookieStickinessPolicy
- string
- The name of the application cookie used for stickiness.
- Policy
Name string - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
- string
- The name of the application cookie used for stickiness.
- Policy
Name string - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
- String
- The name of the application cookie used for stickiness.
- policy
Name String - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
- string
- The name of the application cookie used for stickiness.
- policy
Name string - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
- str
- The name of the application cookie used for stickiness.
- policy_
name str - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
- String
- The name of the application cookie used for stickiness.
- policy
Name String - The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
LoadBalancerConnectionDrainingPolicy
LoadBalancerConnectionSettings
- Idle
Timeout int - The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
- Idle
Timeout int - The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
- idle
Timeout Integer - The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
- idle
Timeout number - The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
- idle_
timeout int - The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
- idle
Timeout Number - The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
LoadBalancerHealthCheck
- Healthy
Threshold string - The number of consecutive health checks successes required before moving the instance to the
Healthystate. - Interval string
- The approximate interval, in seconds, between health checks of an individual instance.
- Target string
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- Timeout string
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Intervalvalue.- Unhealthy
Threshold string - The number of consecutive health check failures required before moving the instance to the
Unhealthystate.
- Healthy
Threshold string - The number of consecutive health checks successes required before moving the instance to the
Healthystate. - Interval string
- The approximate interval, in seconds, between health checks of an individual instance.
- Target string
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- Timeout string
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Intervalvalue.- Unhealthy
Threshold string - The number of consecutive health check failures required before moving the instance to the
Unhealthystate.
- healthy
Threshold String - The number of consecutive health checks successes required before moving the instance to the
Healthystate. - interval String
- The approximate interval, in seconds, between health checks of an individual instance.
- target String
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- timeout String
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Intervalvalue.- unhealthy
Threshold String - The number of consecutive health check failures required before moving the instance to the
Unhealthystate.
- healthy
Threshold string - The number of consecutive health checks successes required before moving the instance to the
Healthystate. - interval string
- The approximate interval, in seconds, between health checks of an individual instance.
- target string
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- timeout string
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Intervalvalue.- unhealthy
Threshold string - The number of consecutive health check failures required before moving the instance to the
Unhealthystate.
- healthy_
threshold str - The number of consecutive health checks successes required before moving the instance to the
Healthystate. - interval str
- The approximate interval, in seconds, between health checks of an individual instance.
- target str
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- timeout str
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Intervalvalue.- unhealthy_
threshold str - The number of consecutive health check failures required before moving the instance to the
Unhealthystate.
- healthy
Threshold String - The number of consecutive health checks successes required before moving the instance to the
Healthystate. - interval String
- The approximate interval, in seconds, between health checks of an individual instance.
- target String
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- timeout String
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Intervalvalue.- unhealthy
Threshold String - The number of consecutive health check failures required before moving the instance to the
Unhealthystate.
LoadBalancerLbCookieStickinessPolicy
- string
- The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
- Policy
Name string - The name of the policy. This name must be unique within the set of policies for this load balancer.
- string
- The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
- Policy
Name string - The name of the policy. This name must be unique within the set of policies for this load balancer.
- String
- The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
- policy
Name String - The name of the policy. This name must be unique within the set of policies for this load balancer.
- string
- The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
- policy
Name string - The name of the policy. This name must be unique within the set of policies for this load balancer.
- str
- The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
- policy_
name str - The name of the policy. This name must be unique within the set of policies for this load balancer.
- String
- The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
- policy
Name String - The name of the policy. This name must be unique within the set of policies for this load balancer.
LoadBalancerListeners
- Instance
Port string - The port on which the instance is listening.
- Load
Balancer stringPort - The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
- Protocol string
- The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
- Instance
Protocol string The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
If there is another listener with the same
InstancePortwhoseInstanceProtocolis secure, (HTTPS or SSL), the listener'sInstanceProtocolmust also be secure.If there is another listener with the same
InstancePortwhoseInstanceProtocolis HTTP or TCP, the listener'sInstanceProtocolmust be HTTP or TCP.- Policy
Names List<string> - The names of the policies to associate with the listener.
- Ssl
Certificate stringId - The Amazon Resource Name (ARN) of the server certificate.
- Instance
Port string - The port on which the instance is listening.
- Load
Balancer stringPort - The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
- Protocol string
- The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
- Instance
Protocol string The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
If there is another listener with the same
InstancePortwhoseInstanceProtocolis secure, (HTTPS or SSL), the listener'sInstanceProtocolmust also be secure.If there is another listener with the same
InstancePortwhoseInstanceProtocolis HTTP or TCP, the listener'sInstanceProtocolmust be HTTP or TCP.- Policy
Names []string - The names of the policies to associate with the listener.
- Ssl
Certificate stringId - The Amazon Resource Name (ARN) of the server certificate.
- instance
Port String - The port on which the instance is listening.
- load
Balancer StringPort - The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
- protocol String
- The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
- instance
Protocol String The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
If there is another listener with the same
InstancePortwhoseInstanceProtocolis secure, (HTTPS or SSL), the listener'sInstanceProtocolmust also be secure.If there is another listener with the same
InstancePortwhoseInstanceProtocolis HTTP or TCP, the listener'sInstanceProtocolmust be HTTP or TCP.- policy
Names List<String> - The names of the policies to associate with the listener.
- ssl
Certificate StringId - The Amazon Resource Name (ARN) of the server certificate.
- instance
Port string - The port on which the instance is listening.
- load
Balancer stringPort - The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
- protocol string
- The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
- instance
Protocol string The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
If there is another listener with the same
InstancePortwhoseInstanceProtocolis secure, (HTTPS or SSL), the listener'sInstanceProtocolmust also be secure.If there is another listener with the same
InstancePortwhoseInstanceProtocolis HTTP or TCP, the listener'sInstanceProtocolmust be HTTP or TCP.- policy
Names string[] - The names of the policies to associate with the listener.
- ssl
Certificate stringId - The Amazon Resource Name (ARN) of the server certificate.
- instance_
port str - The port on which the instance is listening.
- load_
balancer_ strport - The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
- protocol str
- The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
- instance_
protocol str The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
If there is another listener with the same
InstancePortwhoseInstanceProtocolis secure, (HTTPS or SSL), the listener'sInstanceProtocolmust also be secure.If there is another listener with the same
InstancePortwhoseInstanceProtocolis HTTP or TCP, the listener'sInstanceProtocolmust be HTTP or TCP.- policy_
names Sequence[str] - The names of the policies to associate with the listener.
- ssl_
certificate_ strid - The Amazon Resource Name (ARN) of the server certificate.
- instance
Port String - The port on which the instance is listening.
- load
Balancer StringPort - The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
- protocol String
- The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
- instance
Protocol String The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
If there is another listener with the same
InstancePortwhoseInstanceProtocolis secure, (HTTPS or SSL), the listener'sInstanceProtocolmust also be secure.If there is another listener with the same
InstancePortwhoseInstanceProtocolis HTTP or TCP, the listener'sInstanceProtocolmust be HTTP or TCP.- policy
Names List<String> - The names of the policies to associate with the listener.
- ssl
Certificate StringId - The Amazon Resource Name (ARN) of the server certificate.
LoadBalancerPolicies
- Attributes List<object>
- The policy attributes.
- Policy
Name string - The name of the policy.
- Policy
Type string - The name of the policy type.
- Instance
Ports List<string> - The instance ports for the policy. Required only for some policy types.
- Load
Balancer List<string>Ports - The load balancer ports for the policy. Required only for some policy types.
- Attributes []interface{}
- The policy attributes.
- Policy
Name string - The name of the policy.
- Policy
Type string - The name of the policy type.
- Instance
Ports []string - The instance ports for the policy. Required only for some policy types.
- Load
Balancer []stringPorts - The load balancer ports for the policy. Required only for some policy types.
- attributes List<Object>
- The policy attributes.
- policy
Name String - The name of the policy.
- policy
Type String - The name of the policy type.
- instance
Ports List<String> - The instance ports for the policy. Required only for some policy types.
- load
Balancer List<String>Ports - The load balancer ports for the policy. Required only for some policy types.
- attributes any[]
- The policy attributes.
- policy
Name string - The name of the policy.
- policy
Type string - The name of the policy type.
- instance
Ports string[] - The instance ports for the policy. Required only for some policy types.
- load
Balancer string[]Ports - The load balancer ports for the policy. Required only for some policy types.
- attributes Sequence[Any]
- The policy attributes.
- policy_
name str - The name of the policy.
- policy_
type str - The name of the policy type.
- instance_
ports Sequence[str] - The instance ports for the policy. Required only for some policy types.
- load_
balancer_ Sequence[str]ports - The load balancer ports for the policy. Required only for some policy types.
- attributes List<Any>
- The policy attributes.
- policy
Name String - The name of the policy.
- policy
Type String - The name of the policy type.
- instance
Ports List<String> - The instance ports for the policy. Required only for some policy types.
- load
Balancer List<String>Ports - The load balancer ports for the policy. Required only for some policy types.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Apr 20, 2026 by Pulumi
