AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

EndpointDescription

import "github.com/aws/aws-sdk-go/service/globalaccelerator"

type EndpointDescription struct { EndpointId *string `type:"string"` HealthReason *string `type:"string"` HealthState *string `type:"string" enum:"HealthState"` Weight *int64 `type:"integer"` }

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

EndpointId

Type: *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.

HealthReason

Type: *string

The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

If the endpoint state is unhealthy, the reason code can be one of the following values:

  • Timeout: The health check requests to the endpoint are timing out before returning a status.

  • Failed: The health check failed, for example because the endpoint response was invalid (malformed).

If the endpoint state is initial, the reason code can be one of the following values:

  • ProvisioningInProgress: The endpoint is in the process of being provisioned.

  • InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

HealthState

Type: *string

The health status of the endpoint.

Weight

Type: *int64

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 (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) in the AWS Global Accelerator Developer Guide.

Method

GoString

func (s EndpointDescription) GoString() string

GoString returns the string representation

SetEndpointId

func (s *EndpointDescription) SetEndpointId(v string) *EndpointDescription

SetEndpointId sets the EndpointId field's value.

SetHealthReason

func (s *EndpointDescription) SetHealthReason(v string) *EndpointDescription

SetHealthReason sets the HealthReason field's value.

SetHealthState

func (s *EndpointDescription) SetHealthState(v string) *EndpointDescription

SetHealthState sets the HealthState field's value.

SetWeight

func (s *EndpointDescription) SetWeight(v int64) *EndpointDescription

SetWeight sets the Weight field's value.

String

func (s EndpointDescription) String() string

String returns the string representation

On this page: