Skip to content

LoadBalancer

Source code in docs_src/capo_elastic_load_balancing_v2/types/load_balancer.py
class LoadBalancer(TypedDict, closed=True):
    load_balancer_arn: NotRequired[
        "capo_elastic_load_balancing_v2.types.load_balancer_arn.LoadBalancerArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the load balancer.</p>"""
    dns_name: NotRequired["capo_elastic_load_balancing_v2.types.dns_name.DNSName"]
    """<p>The public DNS name of the load balancer.</p>"""
    canonical_hosted_zone_id: NotRequired[
        "capo_elastic_load_balancing_v2.types.canonical_hosted_zone_id.CanonicalHostedZoneId"
    ]
    """<p>The ID of the Amazon Route 53 hosted zone associated with the load balancer.</p>"""
    created_time: NotRequired[
        "capo_elastic_load_balancing_v2.types.created_time.CreatedTime"
    ]
    """<p>The date and time the load balancer was created.</p>"""
    load_balancer_name: NotRequired[
        "capo_elastic_load_balancing_v2.types.load_balancer_name.LoadBalancerName"
    ]
    """<p>The name of the load balancer.</p>"""
    scheme: NotRequired[
        "capo_elastic_load_balancing_v2.types.load_balancer_scheme_enum.LoadBalancerSchemeEnum"
    ]
    """<p>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.</p> <p>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.</p>"""
    vpc_id: NotRequired["capo_elastic_load_balancing_v2.types.vpc_id.VpcId"]
    """<p>The ID of the VPC for the load balancer.</p>"""
    state: NotRequired[
        "capo_elastic_load_balancing_v2.types.load_balancer_state.LoadBalancerState"
    ]
    """<p>The state of the load balancer.</p>"""
    type: NotRequired[
        "capo_elastic_load_balancing_v2.types.load_balancer_type_enum.LoadBalancerTypeEnum"
    ]
    """<p>The type of load balancer.</p>"""
    availability_zones: NotRequired[
        "capo_elastic_load_balancing_v2.types.availability_zones.AvailabilityZones"
    ]
    """<p>The subnets for the load balancer.</p>"""
    security_groups: NotRequired[
        "capo_elastic_load_balancing_v2.types.security_groups.SecurityGroups"
    ]
    """<p>The IDs of the security groups for the load balancer.</p>"""
    ip_address_type: NotRequired[
        "capo_elastic_load_balancing_v2.types.ip_address_type.IpAddressType"
    ]
    """<p>The type of IP addresses used for public or private connections by the subnets attached to your load balancer.</p> <p>[Application Load Balancers] The possible values are <code>ipv4</code> (IPv4 addresses), <code>dualstack</code> (IPv4 and IPv6 addresses), and <code>dualstack-without-public-ipv4</code> (public IPv6 addresses and private IPv4 and IPv6 addresses).</p> <p>[Network Load Balancers and Gateway Load Balancers] The possible values are <code>ipv4</code> (IPv4 addresses) and <code>dualstack</code> (IPv4 and IPv6 addresses).</p>"""
    customer_owned_ipv4_pool: NotRequired[
        "capo_elastic_load_balancing_v2.types.customer_owned_ipv4_pool.CustomerOwnedIpv4Pool"
    ]
    """<p>[Application Load Balancers on Outposts] The ID of the customer-owned address pool.</p>"""
    enforce_security_group_inbound_rules_on_private_link_traffic: NotRequired[
        "capo_elastic_load_balancing_v2.types.enforce_security_group_inbound_rules_on_private_link_traffic.EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic"
    ]
    """<p>Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.</p>"""
    enable_prefix_for_ipv6_source_nat: NotRequired[
        "capo_elastic_load_balancing_v2.types.enable_prefix_for_ipv6_source_nat_enum.EnablePrefixForIpv6SourceNatEnum"
    ]
    """<p>[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 <code>dualstack</code>. The default value is <code>off</code>.</p>"""
    ipam_pools: NotRequired["capo_elastic_load_balancing_v2.types.ipam_pools.IpamPools"]
    """<p>[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.</p>"""

availability_zones instance-attribute

availability_zones: NotRequired[AvailabilityZones]

The subnets for the load balancer.

canonical_hosted_zone_id instance-attribute

canonical_hosted_zone_id: NotRequired[CanonicalHostedZoneId]

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

created_time instance-attribute

created_time: NotRequired[CreatedTime]

The date and time the load balancer was created.

customer_owned_ipv4_pool instance-attribute

customer_owned_ipv4_pool: NotRequired[CustomerOwnedIpv4Pool]

[Application Load Balancers on Outposts] The ID of the customer-owned address pool.

dns_name instance-attribute

dns_name: NotRequired[DNSName]

The public DNS name of the load balancer.

enable_prefix_for_ipv6_source_nat instance-attribute

enable_prefix_for_ipv6_source_nat: NotRequired[EnablePrefixForIpv6SourceNatEnum]

[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 is off.

enforce_security_group_inbound_rules_on_private_link_traffic: NotRequired[
    EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic
]

Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.

ip_address_type instance-attribute

ip_address_type: NotRequired[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), and dualstack-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) and dualstack (IPv4 and IPv6 addresses).

ipam_pools instance-attribute

ipam_pools: NotRequired[IpamPools]

[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.

load_balancer_arn instance-attribute

load_balancer_arn: NotRequired[LoadBalancerArn]

The Amazon Resource Name (ARN) of the load balancer.

load_balancer_name instance-attribute

load_balancer_name: NotRequired[LoadBalancerName]

The name of the load balancer.

scheme instance-attribute

scheme: NotRequired[LoadBalancerSchemeEnum]

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.

security_groups instance-attribute

security_groups: NotRequired[SecurityGroups]

The IDs of the security groups for the load balancer.

state instance-attribute

state: NotRequired[LoadBalancerState]

The state of the load balancer.

type instance-attribute

type: NotRequired[LoadBalancerTypeEnum]

The type of load balancer.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The ID of the VPC for the load balancer.