Amazonka.GlobalAccelerator.Types.EndpointGroup

Documentation

data EndpointGroup

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

See: newEndpointGroup smart constructor.

Constructors

EndpointGroup'

Fields

• endpointDescriptions :: Maybe [EndpointDescription]

  The list of endpoint objects.

• endpointGroupArn :: Maybe Text

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

• endpointGroupRegion :: Maybe Text

  The Amazon Web Services Region where the endpoint group is located.

• healthCheckIntervalSeconds :: Maybe Natural

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

• healthCheckPath :: Maybe Text

  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 :: Maybe Natural

  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 :: Maybe HealthCheckProtocol

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

• portOverrides :: Maybe [PortOverride]

  Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

• thresholdCount :: Maybe Natural

  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 :: Maybe Double

  The percentage of traffic to send to an Amazon Web Services 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.

Instances

FromJSON EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

Methods

parseJSON :: Value -> Parser EndpointGroup

parseJSONList :: Value -> Parser [EndpointGroup]

Generic EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

Associated Types

type Rep EndpointGroup :: Type -> Type

Methods

from :: EndpointGroup -> Rep EndpointGroup x

to :: Rep EndpointGroup x -> EndpointGroup

Read EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

Methods

readsPrec :: Int -> ReadS EndpointGroup

readList :: ReadS [EndpointGroup]

readPrec :: ReadPrec EndpointGroup

readListPrec :: ReadPrec [EndpointGroup]

Show EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

Methods

showsPrec :: Int -> EndpointGroup -> ShowS

show :: EndpointGroup -> String

showList :: [EndpointGroup] -> ShowS

NFData EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

Methods

rnf :: EndpointGroup -> ()

Eq EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

Methods

(==) :: EndpointGroup -> EndpointGroup -> Bool

(/=) :: EndpointGroup -> EndpointGroup -> Bool

Hashable EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

Methods

hashWithSalt :: Int -> EndpointGroup -> Int

hash :: EndpointGroup -> Int

type Rep EndpointGroup

Defined in Amazonka.GlobalAccelerator.Types.EndpointGroup

type Rep EndpointGroup = D1 ('MetaData "EndpointGroup" "Amazonka.GlobalAccelerator.Types.EndpointGroup" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "EndpointGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "endpointDescriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointDescription])) :*: S1 ('MetaSel ('Just "endpointGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endpointGroupRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "healthCheckIntervalSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "healthCheckPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "healthCheckPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "healthCheckProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheckProtocol))) :*: (S1 ('MetaSel ('Just "portOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PortOverride])) :*: (S1 ('MetaSel ('Just "thresholdCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "trafficDialPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))))

newEndpointGroup :: EndpointGroup

Create a value of EndpointGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointDescriptions:EndpointGroup', endpointGroup_endpointDescriptions - The list of endpoint objects.

$sel:endpointGroupArn:EndpointGroup', endpointGroup_endpointGroupArn - The Amazon Resource Name (ARN) of the endpoint group.

$sel:endpointGroupRegion:EndpointGroup', endpointGroup_endpointGroupRegion - The Amazon Web Services Region where the endpoint group is located.

$sel:healthCheckIntervalSeconds:EndpointGroup', endpointGroup_healthCheckIntervalSeconds - The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

$sel:healthCheckPath:EndpointGroup', endpointGroup_healthCheckPath - 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 (/).

$sel:healthCheckPort:EndpointGroup', endpointGroup_healthCheckPort - 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.

$sel:healthCheckProtocol:EndpointGroup', endpointGroup_healthCheckProtocol - The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

$sel:portOverrides:EndpointGroup', endpointGroup_portOverrides - Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

$sel:thresholdCount:EndpointGroup', endpointGroup_thresholdCount - 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.

$sel:trafficDialPercentage:EndpointGroup', endpointGroup_trafficDialPercentage - The percentage of traffic to send to an Amazon Web Services 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.

endpointGroup_endpointDescriptions :: Lens' EndpointGroup (Maybe [EndpointDescription])

The list of endpoint objects.

endpointGroup_endpointGroupArn :: Lens' EndpointGroup (Maybe Text)

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

endpointGroup_endpointGroupRegion :: Lens' EndpointGroup (Maybe Text)

The Amazon Web Services Region where the endpoint group is located.

endpointGroup_healthCheckIntervalSeconds :: Lens' EndpointGroup (Maybe Natural)

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

endpointGroup_healthCheckPath :: Lens' EndpointGroup (Maybe Text)

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 (/).

endpointGroup_healthCheckPort :: Lens' EndpointGroup (Maybe Natural)

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.

endpointGroup_healthCheckProtocol :: Lens' EndpointGroup (Maybe HealthCheckProtocol)

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

endpointGroup_portOverrides :: Lens' EndpointGroup (Maybe [PortOverride])

Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

endpointGroup_thresholdCount :: Lens' EndpointGroup (Maybe Natural)

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.

endpointGroup_trafficDialPercentage :: Lens' EndpointGroup (Maybe Double)

The percentage of traffic to send to an Amazon Web Services 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.