libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GlobalAccelerator.UpdateEndpointGroup

Description

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

Synopsis

Creating a Request

data UpdateEndpointGroup Source #

See: newUpdateEndpointGroup smart constructor.

Constructors

UpdateEndpointGroup' 

Fields

  • 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.

  • healthCheckPath :: Maybe Text

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

  • healthCheckIntervalSeconds :: Maybe Natural

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

  • healthCheckProtocol :: Maybe HealthCheckProtocol

    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.

  • trafficDialPercentage :: Maybe Double

    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.

  • endpointConfigurations :: Maybe [EndpointConfiguration]

    The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.

  • healthCheckPort :: Maybe Natural

    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 the listener port is a list of ports, Global Accelerator uses the first port in the list.

  • portOverrides :: Maybe [PortOverride]

    Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

    For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

  • endpointGroupArn :: Text

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

Instances

Instances details
Eq UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Read UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Show UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Generic UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Associated Types

type Rep UpdateEndpointGroup :: Type -> Type #

NFData UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Methods

rnf :: UpdateEndpointGroup -> () #

Hashable UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

ToJSON UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

AWSRequest UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Associated Types

type AWSResponse UpdateEndpointGroup #

ToHeaders UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

ToPath UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

ToQuery UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

type Rep UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

type Rep UpdateEndpointGroup = D1 ('MetaData "UpdateEndpointGroup" "Amazonka.GlobalAccelerator.UpdateEndpointGroup" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "UpdateEndpointGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "thresholdCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "healthCheckPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "healthCheckIntervalSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "healthCheckProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheckProtocol)))) :*: ((S1 ('MetaSel ('Just "trafficDialPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "endpointConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointConfiguration]))) :*: (S1 ('MetaSel ('Just "healthCheckPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "portOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PortOverride])) :*: S1 ('MetaSel ('Just "endpointGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateEndpointGroup Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

newUpdateEndpointGroup Source #

Create a value of UpdateEndpointGroup 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:thresholdCount:UpdateEndpointGroup', updateEndpointGroup_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:healthCheckPath:UpdateEndpointGroup', updateEndpointGroup_healthCheckPath - If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

$sel:healthCheckIntervalSeconds:UpdateEndpointGroup', updateEndpointGroup_healthCheckIntervalSeconds - The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

$sel:healthCheckProtocol:UpdateEndpointGroup', updateEndpointGroup_healthCheckProtocol - 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.

$sel:trafficDialPercentage:UpdateEndpointGroup', updateEndpointGroup_trafficDialPercentage - 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.

$sel:endpointConfigurations:UpdateEndpointGroup', updateEndpointGroup_endpointConfigurations - The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.

$sel:healthCheckPort:UpdateEndpointGroup', updateEndpointGroup_healthCheckPort - 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 the listener port is a list of ports, Global Accelerator uses the first port in the list.

$sel:portOverrides:UpdateEndpointGroup', updateEndpointGroup_portOverrides - Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

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

Request Lenses

updateEndpointGroup_thresholdCount :: Lens' UpdateEndpointGroup (Maybe Natural) Source #

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.

updateEndpointGroup_healthCheckPath :: Lens' UpdateEndpointGroup (Maybe Text) Source #

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

updateEndpointGroup_healthCheckIntervalSeconds :: Lens' UpdateEndpointGroup (Maybe Natural) Source #

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

updateEndpointGroup_healthCheckProtocol :: Lens' UpdateEndpointGroup (Maybe HealthCheckProtocol) Source #

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.

updateEndpointGroup_trafficDialPercentage :: Lens' UpdateEndpointGroup (Maybe Double) Source #

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.

updateEndpointGroup_endpointConfigurations :: Lens' UpdateEndpointGroup (Maybe [EndpointConfiguration]) Source #

The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.

updateEndpointGroup_healthCheckPort :: Lens' UpdateEndpointGroup (Maybe Natural) Source #

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 the listener port is a list of ports, Global Accelerator uses the first port in the list.

updateEndpointGroup_portOverrides :: Lens' UpdateEndpointGroup (Maybe [PortOverride]) Source #

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

updateEndpointGroup_endpointGroupArn :: Lens' UpdateEndpointGroup Text Source #

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

Destructuring the Response

data UpdateEndpointGroupResponse Source #

See: newUpdateEndpointGroupResponse smart constructor.

Constructors

UpdateEndpointGroupResponse' 

Fields

Instances

Instances details
Eq UpdateEndpointGroupResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Read UpdateEndpointGroupResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Show UpdateEndpointGroupResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Generic UpdateEndpointGroupResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

Associated Types

type Rep UpdateEndpointGroupResponse :: Type -> Type #

NFData UpdateEndpointGroupResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

type Rep UpdateEndpointGroupResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.UpdateEndpointGroup

type Rep UpdateEndpointGroupResponse = D1 ('MetaData "UpdateEndpointGroupResponse" "Amazonka.GlobalAccelerator.UpdateEndpointGroup" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "UpdateEndpointGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateEndpointGroupResponse Source #

Create a value of UpdateEndpointGroupResponse 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:endpointGroup:UpdateEndpointGroupResponse', updateEndpointGroupResponse_endpointGroup - The information about the endpoint group that was updated.

$sel:httpStatus:UpdateEndpointGroupResponse', updateEndpointGroupResponse_httpStatus - The response's http status code.

Response Lenses

updateEndpointGroupResponse_endpointGroup :: Lens' UpdateEndpointGroupResponse (Maybe EndpointGroup) Source #

The information about the endpoint group that was updated.