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.

EndpointGroup

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

type EndpointGroup struct { EndpointDescriptions []*EndpointDescription `type:"list"` EndpointGroupArn *string `type:"string"` EndpointGroupRegion *string `type:"string"` HealthCheckIntervalSeconds *int64 `min:"10" type:"integer"` HealthCheckPath *string `type:"string"` HealthCheckPort *int64 `min:"1" type:"integer"` HealthCheckProtocol *string `type:"string" enum:"HealthCheckProtocol"` ThresholdCount *int64 `min:"1" type:"integer"` TrafficDialPercentage *float64 `type:"float"` }

A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.

EndpointDescriptions

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

EndpointGroupArn

Type: *string

The Amazon Resource Name (ARN) of the endpoint group.

EndpointGroupRegion

Type: *string

The AWS Region that this endpoint group belongs.

HealthCheckIntervalSeconds

Type: *int64

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

HealthCheckPath

Type: *string

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

HealthCheckPort

Type: *int64

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

HealthCheckProtocol

Type: *string

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

ThresholdCount

Type: *int64

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

TrafficDialPercentage

Type: *float64

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

Method

GoString

func (s EndpointGroup) GoString() string

GoString returns the string representation

SetEndpointDescriptions

func (s *EndpointGroup) SetEndpointDescriptions(v []*EndpointDescription) *EndpointGroup

SetEndpointDescriptions sets the EndpointDescriptions field's value.

SetEndpointGroupArn

func (s *EndpointGroup) SetEndpointGroupArn(v string) *EndpointGroup

SetEndpointGroupArn sets the EndpointGroupArn field's value.

SetEndpointGroupRegion

func (s *EndpointGroup) SetEndpointGroupRegion(v string) *EndpointGroup

SetEndpointGroupRegion sets the EndpointGroupRegion field's value.

SetHealthCheckIntervalSeconds

func (s *EndpointGroup) SetHealthCheckIntervalSeconds(v int64) *EndpointGroup

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

SetHealthCheckPath

func (s *EndpointGroup) SetHealthCheckPath(v string) *EndpointGroup

SetHealthCheckPath sets the HealthCheckPath field's value.

SetHealthCheckPort

func (s *EndpointGroup) SetHealthCheckPort(v int64) *EndpointGroup

SetHealthCheckPort sets the HealthCheckPort field's value.

SetHealthCheckProtocol

func (s *EndpointGroup) SetHealthCheckProtocol(v string) *EndpointGroup

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

SetThresholdCount

func (s *EndpointGroup) SetThresholdCount(v int64) *EndpointGroup

SetThresholdCount sets the ThresholdCount field's value.

SetTrafficDialPercentage

func (s *EndpointGroup) SetTrafficDialPercentage(v float64) *EndpointGroup

SetTrafficDialPercentage sets the TrafficDialPercentage field's value.

String

func (s EndpointGroup) String() string

String returns the string representation

On this page: