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.

CreateEndpointGroupInput

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

type CreateEndpointGroupInput struct { EndpointConfigurations []*EndpointConfiguration `type:"list"` EndpointGroupRegion *string `type:"string" required:"true"` HealthCheckIntervalSeconds *int64 `min:"10" type:"integer"` HealthCheckPath *string `type:"string"` HealthCheckPort *int64 `min:"1" type:"integer"` HealthCheckProtocol *string `type:"string" enum:"HealthCheckProtocol"` IdempotencyToken *string `type:"string" required:"true"` ListenerArn *string `type:"string" required:"true"` ThresholdCount *int64 `min:"1" type:"integer"` TrafficDialPercentage *float64 `type:"float"` }

EndpointConfigurations

A complex type for endpoints.

EndpointGroupRegion

Type: *string

The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

EndpointGroupRegion is a required field

HealthCheckIntervalSeconds

Type: *int64

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

HealthCheckPath

Type: *string

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

HealthCheckPort

Type: *int64

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

HealthCheckProtocol

Type: *string

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

IdempotencyToken

Type: *string

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

IdempotencyToken is a required field

ListenerArn

Type: *string

The Amazon Resource Name (ARN) of the listener.

ListenerArn is a required field

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 CreateEndpointGroupInput) GoString() string

GoString returns the string representation

SetEndpointConfigurations

func (s *CreateEndpointGroupInput) SetEndpointConfigurations(v []*EndpointConfiguration) *CreateEndpointGroupInput

SetEndpointConfigurations sets the EndpointConfigurations field's value.

SetEndpointGroupRegion

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

SetEndpointGroupRegion sets the EndpointGroupRegion field's value.

SetHealthCheckIntervalSeconds

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

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

SetHealthCheckPath

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

SetHealthCheckPath sets the HealthCheckPath field's value.

SetHealthCheckPort

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

SetHealthCheckPort sets the HealthCheckPort field's value.

SetHealthCheckProtocol

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

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

SetIdempotencyToken

func (s *CreateEndpointGroupInput) SetIdempotencyToken(v string) *CreateEndpointGroupInput

SetIdempotencyToken sets the IdempotencyToken field's value.

SetListenerArn

func (s *CreateEndpointGroupInput) SetListenerArn(v string) *CreateEndpointGroupInput

SetListenerArn sets the ListenerArn field's value.

SetThresholdCount

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

SetThresholdCount sets the ThresholdCount field's value.

SetTrafficDialPercentage

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

SetTrafficDialPercentage sets the TrafficDialPercentage field's value.

String

func (s CreateEndpointGroupInput) String() string

String returns the string representation

Validate

func (s *CreateEndpointGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: