Skip to content

LoadBalancerDescription

Source code in docs_src/capo_elastic_load_balancing/types/load_balancer_description.py
class LoadBalancerDescription(TypedDict, closed=True):
    load_balancer_name: NotRequired[
        "capo_elastic_load_balancing.types.access_point_name.AccessPointName"
    ]
    """<p>The name of the load balancer.</p>"""
    dns_name: NotRequired["capo_elastic_load_balancing.types.dns_name.DNSName"]
    """<p>The DNS name of the load balancer.</p>"""
    canonical_hosted_zone_name: NotRequired[
        "capo_elastic_load_balancing.types.dns_name.DNSName"
    ]
    """<p>The DNS name of the load balancer.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html">Configure a Custom Domain Name</a> in the <i>Classic Load Balancers Guide</i>.</p>"""
    canonical_hosted_zone_name_id: NotRequired[
        "capo_elastic_load_balancing.types.dns_name.DNSName"
    ]
    """<p>The ID of the Amazon Route 53 hosted zone for the load balancer.</p>"""
    listener_descriptions: NotRequired[
        "capo_elastic_load_balancing.types.listener_descriptions.ListenerDescriptions"
    ]
    """<p>The listeners for the load balancer.</p>"""
    policies: NotRequired["capo_elastic_load_balancing.types.policies.Policies"]
    """<p>The policies defined for the load balancer.</p>"""
    backend_server_descriptions: NotRequired[
        "capo_elastic_load_balancing.types.backend_server_descriptions.BackendServerDescriptions"
    ]
    """<p>Information about your EC2 instances.</p>"""
    availability_zones: NotRequired[
        "capo_elastic_load_balancing.types.availability_zones.AvailabilityZones"
    ]
    """<p>The Availability Zones for the load balancer.</p>"""
    subnets: NotRequired["capo_elastic_load_balancing.types.subnets.Subnets"]
    """<p>The IDs of the subnets for the load balancer.</p>"""
    vpc_id: NotRequired["capo_elastic_load_balancing.types.vpc_id.VPCId"]
    """<p>The ID of the VPC for the load balancer.</p>"""
    instances: NotRequired["capo_elastic_load_balancing.types.instances.Instances"]
    """<p>The IDs of the instances for the load balancer.</p>"""
    health_check: NotRequired[
        "capo_elastic_load_balancing.types.health_check.HealthCheck"
    ]
    """<p>Information about the health checks conducted on the load balancer.</p>"""
    source_security_group: NotRequired[
        "capo_elastic_load_balancing.types.source_security_group.SourceSecurityGroup"
    ]
    """<p>The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.</p>"""
    security_groups: NotRequired[
        "capo_elastic_load_balancing.types.security_groups.SecurityGroups"
    ]
    """<p>The security groups for the load balancer. Valid only for load balancers in a VPC.</p>"""
    created_time: NotRequired[
        "capo_elastic_load_balancing.types.created_time.CreatedTime"
    ]
    """<p>The date and time the load balancer was created.</p>"""
    scheme: NotRequired[
        "capo_elastic_load_balancing.types.load_balancer_scheme.LoadBalancerScheme"
    ]
    """<p>The type of load balancer. Valid only for load balancers in a VPC.</p> <p>If <code>Scheme</code> is <code>internet-facing</code>, the load balancer has a public DNS name that resolves to a public IP address.</p> <p>If <code>Scheme</code> is <code>internal</code>, the load balancer has a public DNS name that resolves to a private IP address.</p>"""

availability_zones instance-attribute

availability_zones: NotRequired[AvailabilityZones]

The Availability Zones for the load balancer.

backend_server_descriptions instance-attribute

backend_server_descriptions: NotRequired[BackendServerDescriptions]

Information about your EC2 instances.

canonical_hosted_zone_name instance-attribute

canonical_hosted_zone_name: NotRequired[DNSName]

The DNS name of the load balancer.

For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.

canonical_hosted_zone_name_id instance-attribute

canonical_hosted_zone_name_id: NotRequired[DNSName]

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

created_time instance-attribute

created_time: NotRequired[CreatedTime]

The date and time the load balancer was created.

dns_name instance-attribute

dns_name: NotRequired[DNSName]

The DNS name of the load balancer.

health_check instance-attribute

health_check: NotRequired[HealthCheck]

Information about the health checks conducted on the load balancer.

instances instance-attribute

instances: NotRequired[Instances]

The IDs of the instances for the load balancer.

listener_descriptions instance-attribute

listener_descriptions: NotRequired[ListenerDescriptions]

The listeners for the load balancer.

load_balancer_name instance-attribute

load_balancer_name: NotRequired[AccessPointName]

The name of the load balancer.

policies instance-attribute

policies: NotRequired[Policies]

The policies defined for the load balancer.

scheme instance-attribute

scheme: NotRequired[LoadBalancerScheme]

The type of load balancer. Valid only for load balancers in a VPC.

If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.

If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.

security_groups instance-attribute

security_groups: NotRequired[SecurityGroups]

The security groups for the load balancer. Valid only for load balancers in a VPC.

source_security_group instance-attribute

source_security_group: NotRequired[SourceSecurityGroup]

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

subnets instance-attribute

subnets: NotRequired[Subnets]

The IDs of the subnets for the load balancer.

vpc_id instance-attribute

vpc_id: NotRequired[VPCId]

The ID of the VPC for the load balancer.