LoadBalancer
Information about a load balancer.
Contents
- AvailabilityZones.member.N
-
The subnets for the load balancer.
Type: Array of AvailabilityZone objects
Required: No
- CanonicalHostedZoneId
-
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
Type: String
Required: No
- CreatedTime
-
The date and time the load balancer was created.
Type: Timestamp
Required: No
- CustomerOwnedIpv4Pool
-
[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^(ipv4pool-coip-)[a-zA-Z0-9]+$Required: No
- DNSName
-
The public DNS name of the load balancer.
Type: String
Required: No
- EnablePrefixForIpv6SourceNat
-
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be
dualstack. The default value isoff.Type: String
Valid Values:
on | offRequired: No
- EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic
-
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink.
Type: String
Required: No
- IpAddressType
-
The type of IP addresses used for public or private connections by the subnets attached to your load balancer.
[Application Load Balancers] The possible values are
ipv4(IPv4 addresses),dualstack(IPv4 and IPv6 addresses), anddualstack-without-public-ipv4(public IPv6 addresses and private IPv4 and IPv6 addresses).[Network Load Balancers and Gateway Load Balancers] The possible values are
ipv4(IPv4 addresses) anddualstack(IPv4 and IPv6 addresses).Type: String
Valid Values:
ipv4 | dualstack | dualstack-without-public-ipv4Required: No
- IpamPools
-
[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.
Type: IpamPools object
Required: No
- LoadBalancerArn
-
The Amazon Resource Name (ARN) of the load balancer.
Type: String
Required: No
- LoadBalancerName
-
The name of the load balancer.
Type: String
Required: No
- Scheme
-
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
Type: String
Valid Values:
internet-facing | internalRequired: No
- SecurityGroups.member.N
-
The IDs of the security groups for the load balancer.
Type: Array of strings
Required: No
- State
-
The state of the load balancer.
Type: LoadBalancerState object
Required: No
- Type
-
The type of load balancer.
Type: String
Valid Values:
application | network | gatewayRequired: No
- VpcId
-
The ID of the VPC for the load balancer.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
