Skip to content

LoadBalancer

Source code in docs_src/capo_lightsail/types/load_balancer.py
class LoadBalancer(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the load balancer (<code>my-load-balancer</code>).</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the load balancer.</p>"""
    support_code: NotRequired["capo_lightsail.types.string.string"]
    """<p>The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.</p>"""
    created_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The date when your load balancer was created.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>The AWS Region where your load balancer was created (<code>us-east-2a</code>). Lightsail automatically creates your load balancer across Availability Zones.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The resource type (<code>LoadBalancer</code>.</p>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>"""
    dns_name: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The DNS name of your Lightsail load balancer.</p>"""
    state: NotRequired["capo_lightsail.types.load_balancer_state.LoadBalancerState"]
    """<p>The status of your load balancer. Valid values are below.</p>"""
    protocol: NotRequired[
        "capo_lightsail.types.load_balancer_protocol.LoadBalancerProtocol"
    ]
    """<p>The protocol you have enabled for your load balancer. Valid values are below.</p> <p>You can't just have <code>HTTP_HTTPS</code>, but you can have just <code>HTTP</code>.</p>"""
    public_ports: NotRequired["capo_lightsail.types.port_list.PortList"]
    """<p>An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.</p>"""
    health_check_path: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.</p>"""
    instance_port: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.</p>"""
    instance_health_summary: NotRequired[
        "capo_lightsail.types.instance_health_summary_list.InstanceHealthSummaryList"
    ]
    """<p>An array of InstanceHealthSummary objects describing the health of the load balancer.</p>"""
    tls_certificate_summaries: NotRequired[
        "capo_lightsail.types.load_balancer_tls_certificate_summary_list.LoadBalancerTlsCertificateSummaryList"
    ]
    """<p>An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if <code>true</code>, the certificate is attached to the load balancer.</p>"""
    configuration_options: NotRequired[
        "capo_lightsail.types.load_balancer_configuration_options.LoadBalancerConfigurationOptions"
    ]
    """<p>A string to string map of the configuration options for your load balancer. Valid values are listed below.</p>"""
    ip_address_type: NotRequired["capo_lightsail.types.ip_address_type.IpAddressType"]
    """<p>The IP address type of the load balancer.</p> <p>The possible values are <code>ipv4</code> for IPv4 only, <code>ipv6</code> for IPv6 only, and <code>dualstack</code> for IPv4 and IPv6.</p>"""
    https_redirection_enabled: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.</p>"""
    tls_policy_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the TLS security policy for the load balancer.</p>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

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

configuration_options instance-attribute

configuration_options: NotRequired[LoadBalancerConfigurationOptions]

A string to string map of the configuration options for your load balancer. Valid values are listed below.

created_at instance-attribute

created_at: NotRequired[IsoDate]

The date when your load balancer was created.

dns_name instance-attribute

dns_name: NotRequired[NonEmptyString]

The DNS name of your Lightsail load balancer.

health_check_path instance-attribute

health_check_path: NotRequired[NonEmptyString]

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

https_redirection_enabled instance-attribute

https_redirection_enabled: NotRequired[boolean]

A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

instance_health_summary instance-attribute

instance_health_summary: NotRequired[InstanceHealthSummaryList]

An array of InstanceHealthSummary objects describing the health of the load balancer.

instance_port instance-attribute

instance_port: NotRequired[integer]

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type of the load balancer.

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

location instance-attribute

location: NotRequired[ResourceLocation]

The AWS Region where your load balancer was created (us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

name instance-attribute

name: NotRequired[ResourceName]

The name of the load balancer (my-load-balancer).

protocol instance-attribute

protocol: NotRequired[LoadBalancerProtocol]

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

public_ports instance-attribute

public_ports: NotRequired[PortList]

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The resource type (LoadBalancer.

state instance-attribute

state: NotRequired[LoadBalancerState]

The status of your load balancer. Valid values are below.

support_code instance-attribute

support_code: NotRequired[string]

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

tags instance-attribute

tags: NotRequired[TagList]

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

tls_certificate_summaries instance-attribute

tls_certificate_summaries: NotRequired[LoadBalancerTlsCertificateSummaryList]

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

tls_policy_name instance-attribute

tls_policy_name: NotRequired[ResourceName]

The name of the TLS security policy for the load balancer.