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
Create LoadBalancer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);@overload
def LoadBalancer(resource_name: str,
args: LoadBalancerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LoadBalancer(resource_name: str,
opts: Optional[ResourceOptions] = None,
listeners: Optional[Sequence[LoadBalancerListenersArgs]] = None,
lb_cookie_stickiness_policy: Optional[Sequence[LoadBalancerLbCookieStickinessPolicyArgs]] = None,
load_balancer_name: Optional[str] = None,
connection_draining_policy: Optional[LoadBalancerConnectionDrainingPolicyArgs] = None,
connection_settings: Optional[LoadBalancerConnectionSettingsArgs] = None,
cross_zone: Optional[bool] = None,
health_check: Optional[LoadBalancerHealthCheckArgs] = None,
instances: Optional[Sequence[str]] = None,
access_logging_policy: Optional[LoadBalancerAccessLoggingPolicyArgs] = None,
availability_zones: Optional[Sequence[str]] = None,
policies: Optional[Sequence[LoadBalancerPoliciesArgs]] = None,
app_cookie_stickiness_policy: Optional[Sequence[LoadBalancerAppCookieStickinessPolicyArgs]] = None,
scheme: Optional[str] = None,
security_groups: Optional[Sequence[str]] = None,
source_security_group_group_name: Optional[str] = None,
source_security_group_owner_alias: Optional[str] = None,
subnets: Optional[Sequence[str]] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)
public LoadBalancer(String name, LoadBalancerArgs args)
public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)
type: aws-native:elasticloadbalancing:LoadBalancer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
LoadBalancer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LoadBalancer resource accepts the following input properties:
- Listeners
List<Pulumi.
Aws Native. Elastic Load Balancing. Inputs. 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.
- Access
Logging Pulumi.Policy Aws Native. Elastic Load Balancing. Inputs. 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. Inputs. 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.
- Connection
Draining Pulumi.Policy Aws Native. Elastic Load Balancing. Inputs. 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. Inputs. 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 .
- Health
Check Pulumi.Aws Native. Elastic Load Balancing. Inputs. 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.
- Instances List<string>
- The IDs of the instances for the load balancer.
-
List<Pulumi.
Aws Native. Elastic Load Balancing. Inputs. Load Balancer Lb Cookie Stickiness Policy> - Information about a policy for duration-based session stickiness.
- Load
Balancer stringName The name of the load balancer. This name must be unique within your set of load balancers for the region.
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
- Policies
List<Pulumi.
Aws Native. Elastic Load Balancing. Inputs. Load Balancer Policies> - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- Scheme string
The type of load balancer. Valid only for load balancers in a VPC.
If
Schemeisinternet-facing, the load balancer has a public DNS name that resolves to a public IP address.If
Schemeisinternal, the load balancer has a public DNS name that resolves to a private IP address.- 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. Inputs. Tag> - The tags associated with a load balancer.
- Listeners
[]Load
Balancer Listeners Args 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.
- Access
Logging LoadPolicy Balancer Access Logging Policy Args - Information about where and how access logs are stored for the load balancer.
-
[]Load
Balancer App Cookie Stickiness Policy Args - 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.
- Connection
Draining LoadPolicy Balancer Connection Draining Policy Args 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 Args 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 .
- Health
Check LoadBalancer Health Check Args 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.
- Instances []string
- The IDs of the instances for the load balancer.
-
[]Load
Balancer Lb Cookie Stickiness Policy Args - Information about a policy for duration-based session stickiness.
- Load
Balancer stringName The name of the load balancer. This name must be unique within your set of load balancers for the region.
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
- Policies
[]Load
Balancer Policies Args - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- Scheme string
The type of load balancer. Valid only for load balancers in a VPC.
If
Schemeisinternet-facing, the load balancer has a public DNS name that resolves to a public IP address.If
Schemeisinternal, the load balancer has a public DNS name that resolves to a private IP address.- 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
Args - The tags associated with a load balancer.
- 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.
- 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.
- 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 .
- 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.
- 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.
- load
Balancer StringName The name of the load balancer. This name must be unique within your set of load balancers for the region.
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
- policies
List<Load
Balancer Policies> - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- scheme String
The type of load balancer. Valid only for load balancers in a VPC.
If
Schemeisinternet-facing, the load balancer has a public DNS name that resolves to a public IP address.If
Schemeisinternal, the load balancer has a public DNS name that resolves to a private IP address.- 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.
- 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.
- 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.
- 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 .
- 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.
- 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.
- load
Balancer stringName The name of the load balancer. This name must be unique within your set of load balancers for the region.
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
- policies
Load
Balancer Policies[] - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- scheme string
The type of load balancer. Valid only for load balancers in a VPC.
If
Schemeisinternet-facing, the load balancer has a public DNS name that resolves to a public IP address.If
Schemeisinternal, the load balancer has a public DNS name that resolves to a private IP address.- 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.
- listeners
Sequence[Load
Balancer Listeners Args] 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.
- access_
logging_ Loadpolicy Balancer Access Logging Policy Args - Information about where and how access logs are stored for the load balancer.
-
Sequence[Load
Balancer App Cookie Stickiness Policy Args] - 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.
- connection_
draining_ Loadpolicy Balancer Connection Draining Policy Args 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 Args 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 .
- health_
check LoadBalancer Health Check Args 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.
- instances Sequence[str]
- The IDs of the instances for the load balancer.
-
Sequence[Load
Balancer Lb Cookie Stickiness Policy Args] - Information about a policy for duration-based session stickiness.
- load_
balancer_ strname The name of the load balancer. This name must be unique within your set of load balancers for the region.
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
- policies
Sequence[Load
Balancer Policies Args] - The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- scheme str
The type of load balancer. Valid only for load balancers in a VPC.
If
Schemeisinternet-facing, the load balancer has a public DNS name that resolves to a public IP address.If
Schemeisinternal, the load balancer has a public DNS name that resolves to a private IP address.- 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[Tag
Args] - The tags associated with a load balancer.
- 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.
- 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.
- 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 .
- 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.
- instances List<String>
- The IDs of the instances for the load balancer.
- List<Property Map>
- Information about a policy for duration-based session stickiness.
- load
Balancer StringName The name of the load balancer. This name must be unique within your set of load balancers for the region.
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see Name Type . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
- policies List<Property Map>
- The policies defined for your Classic Load Balancer. Specify only back-end server policies.
- scheme String
The type of load balancer. Valid only for load balancers in a VPC.
If
Schemeisinternet-facing, the load balancer has a public DNS name that resolves to a public IP address.If
Schemeisinternal, the load balancer has a public DNS name that resolves to a private IP address.- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the LoadBalancer resource produces the following output properties:
- Aws
Id string - 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.
- Dns
Name string - The DNS name for the load balancer.
- Id string
- The provider-assigned unique ID for this managed resource.
- Aws
Id string - 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.
- Dns
Name string - The DNS name for the load balancer.
- Id string
- The provider-assigned unique ID for this managed resource.
- aws
Id String - 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.
- dns
Name String - The DNS name for the load balancer.
- id String
- The provider-assigned unique ID for this managed resource.
- aws
Id string - 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.
- dns
Name string - The DNS name for the load balancer.
- id string
- The provider-assigned unique ID for this managed resource.
- aws_
id str - 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.
- dns_
name str - The DNS name for the load balancer.
- id str
- The provider-assigned unique ID for this managed resource.
- aws
Id String - 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.
- dns
Name String - The DNS name for the load balancer.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
LoadBalancerAccessLoggingPolicy, LoadBalancerAccessLoggingPolicyArgs
- 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, LoadBalancerAppCookieStickinessPolicyArgs
- 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, LoadBalancerConnectionDrainingPolicyArgs
LoadBalancerConnectionSettings, LoadBalancerConnectionSettingsArgs
- 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, LoadBalancerHealthCheckArgs
- 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, LoadBalancerLbCookieStickinessPolicyArgs
- 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, LoadBalancerListenersArgs
- 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, LoadBalancerPoliciesArgs
- 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, TagArgs
A set of tags to apply to the resource.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
