Struct aws_sdk_globalaccelerator::model::EndpointDescription

#[non_exhaustive]
pub struct EndpointDescription {
    pub endpoint_id: Option<String>,
    pub weight: Option<i32>,
    pub health_state: Option<HealthState>,
    pub health_reason: Option<String>,
    pub client_ip_preservation_enabled: Option<bool>,
}

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

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.

endpoint_id: Option<String>

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

An Application Load Balancer can be either internal or internet-facing.

weight: Option<i32>

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

health_state: Option<HealthState>

The health status of the endpoint.

health_reason: Option<String>

Returns a null result.

client_ip_preservation_enabled: Option<bool>

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

Implementations

impl EndpointDescription

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

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

An Application Load Balancer can be either internal or internet-facing.

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

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

pub fn health_state(&self) -> Option<&HealthState>

The health status of the endpoint.

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

Returns a null result.

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

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

impl EndpointDescription

pub fn builder() -> Builder

Creates a new builder-style object to manufacture EndpointDescription.

Trait Implementations

impl Clone for EndpointDescription

fn clone(&self) -> EndpointDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointDescription

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

Formats the value using the given formatter.

impl PartialEq<EndpointDescription> for EndpointDescription

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

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

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

This method tests for !=.

impl StructuralPartialEq for EndpointDescription