Struct aws_sdk_lightsail::types::LoadBalancer

#[non_exhaustive]
pub struct LoadBalancer {

    pub name: Option<String>,
    pub arn: Option<String>,
    pub support_code: Option<String>,
    pub created_at: Option<DateTime>,
    pub location: Option<ResourceLocation>,
    pub resource_type: Option<ResourceType>,
    pub tags: Option<Vec<Tag>>,
    pub dns_name: Option<String>,
    pub state: Option<LoadBalancerState>,
    pub protocol: Option<LoadBalancerProtocol>,
    pub public_ports: Option<Vec<i32>>,
    pub health_check_path: Option<String>,
    pub instance_port: Option<i32>,
    pub instance_health_summary: Option<Vec<InstanceHealthSummary>>,
    pub tls_certificate_summaries: Option<Vec<LoadBalancerTlsCertificateSummary>>,
    pub configuration_options: Option<HashMap<LoadBalancerAttributeName, String>>,
    pub ip_address_type: Option<IpAddressType>,
    pub https_redirection_enabled: Option<bool>,
    pub tls_policy_name: Option<String>,
}

Describes a load balancer.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

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

arn: Option<String>

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

support_code: Option<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.

created_at: Option<DateTime>

The date when your load balancer was created.

location: Option<ResourceLocation>

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

resource_type: Option<ResourceType>

The resource type (LoadBalancer.

tags: Option<Vec<Tag>>

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

dns_name: Option<String>

The DNS name of your Lightsail load balancer.

state: Option<LoadBalancerState>

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

protocol: Option<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: Option<Vec<i32>>

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

health_check_path: Option<String>

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.

instance_port: Option<i32>

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.

instance_health_summary: Option<Vec<InstanceHealthSummary>>

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

tls_certificate_summaries: Option<Vec<LoadBalancerTlsCertificateSummary>>

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.

configuration_options: Option<HashMap<LoadBalancerAttributeName, String>>

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

ip_address_type: Option<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.

https_redirection_enabled: Option<bool>

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

tls_policy_name: Option<String>

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

Implementations

impl LoadBalancer

pub fn name(&self) -> Option<&str>

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

pub fn arn(&self) -> Option<&str>

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

pub fn support_code(&self) -> Option<&str>

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.

pub fn created_at(&self) -> Option<&DateTime>

The date when your load balancer was created.

pub fn location(&self) -> Option<&ResourceLocation>

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

pub fn resource_type(&self) -> Option<&ResourceType>

The resource type (LoadBalancer.

pub fn tags(&self) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn dns_name(&self) -> Option<&str>

The DNS name of your Lightsail load balancer.

pub fn state(&self) -> Option<&LoadBalancerState>

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

pub fn protocol(&self) -> Option<&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.

pub fn public_ports(&self) -> &[i32]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .public_ports.is_none().

pub fn health_check_path(&self) -> Option<&str>

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.

pub fn instance_port(&self) -> Option<i32>

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.

pub fn instance_health_summary(&self) -> &[InstanceHealthSummary]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_health_summary.is_none().

pub fn tls_certificate_summaries(&self) -> &[LoadBalancerTlsCertificateSummary]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tls_certificate_summaries.is_none().

pub fn configuration_options( &self ) -> Option<&HashMap<LoadBalancerAttributeName, String>>

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

pub fn ip_address_type(&self) -> Option<&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.

pub fn https_redirection_enabled(&self) -> Option<bool>

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

pub fn tls_policy_name(&self) -> Option<&str>

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

impl LoadBalancer

pub fn builder() -> LoadBalancerBuilder

Creates a new builder-style object to manufacture LoadBalancer.

Trait Implementations

impl Clone for LoadBalancer

fn clone(&self) -> LoadBalancer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LoadBalancer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LoadBalancer

fn eq(&self, other: &LoadBalancer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LoadBalancer