Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
Synopsis
- data ModifyTargetGroup = ModifyTargetGroup' {
- healthCheckEnabled :: Maybe Bool
- healthCheckIntervalSeconds :: Maybe Natural
- healthCheckPath :: Maybe Text
- healthCheckPort :: Maybe Text
- healthCheckProtocol :: Maybe ProtocolEnum
- healthCheckTimeoutSeconds :: Maybe Natural
- healthyThresholdCount :: Maybe Natural
- matcher :: Maybe Matcher
- unhealthyThresholdCount :: Maybe Natural
- targetGroupArn :: Text
- newModifyTargetGroup :: Text -> ModifyTargetGroup
- modifyTargetGroup_healthCheckEnabled :: Lens' ModifyTargetGroup (Maybe Bool)
- modifyTargetGroup_healthCheckIntervalSeconds :: Lens' ModifyTargetGroup (Maybe Natural)
- modifyTargetGroup_healthCheckPath :: Lens' ModifyTargetGroup (Maybe Text)
- modifyTargetGroup_healthCheckPort :: Lens' ModifyTargetGroup (Maybe Text)
- modifyTargetGroup_healthCheckProtocol :: Lens' ModifyTargetGroup (Maybe ProtocolEnum)
- modifyTargetGroup_healthCheckTimeoutSeconds :: Lens' ModifyTargetGroup (Maybe Natural)
- modifyTargetGroup_healthyThresholdCount :: Lens' ModifyTargetGroup (Maybe Natural)
- modifyTargetGroup_matcher :: Lens' ModifyTargetGroup (Maybe Matcher)
- modifyTargetGroup_unhealthyThresholdCount :: Lens' ModifyTargetGroup (Maybe Natural)
- modifyTargetGroup_targetGroupArn :: Lens' ModifyTargetGroup Text
- data ModifyTargetGroupResponse = ModifyTargetGroupResponse' {
- targetGroups :: Maybe [TargetGroup]
- httpStatus :: Int
- newModifyTargetGroupResponse :: Int -> ModifyTargetGroupResponse
- modifyTargetGroupResponse_targetGroups :: Lens' ModifyTargetGroupResponse (Maybe [TargetGroup])
- modifyTargetGroupResponse_httpStatus :: Lens' ModifyTargetGroupResponse Int
Creating a Request
data ModifyTargetGroup Source #
See: newModifyTargetGroup
smart constructor.
ModifyTargetGroup' | |
|
Instances
Create a value of ModifyTargetGroup
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:
ModifyTargetGroup
, modifyTargetGroup_healthCheckEnabled
- Indicates whether health checks are enabled.
ModifyTargetGroup
, modifyTargetGroup_healthCheckIntervalSeconds
- The approximate amount of time, in seconds, between health checks of an
individual target.
ModifyTargetGroup
, modifyTargetGroup_healthCheckPath
- [HTTP/HTTPS health checks] The destination for health checks on the
targets.
- HTTP1 or HTTP2 protocol version
- The ping path. The default is /.
- GRPC protocol version
- The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.
ModifyTargetGroup
, modifyTargetGroup_healthCheckPort
- The port the load balancer uses when performing health checks on
targets.
ModifyTargetGroup
, modifyTargetGroup_healthCheckProtocol
- The protocol the load balancer uses when performing health checks on
targets. For Application Load Balancers, the default is HTTP. For
Network Load Balancers and Gateway Load Balancers, the default is TCP.
The TCP protocol is not supported for health checks if the protocol of
the target group is HTTP or HTTPS. It is supported for health checks
only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP.
The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health
checks.
ModifyTargetGroup
, modifyTargetGroup_healthCheckTimeoutSeconds
- [HTTP/HTTPS health checks] The amount of time, in seconds, during which
no response means a failed health check.
ModifyTargetGroup
, modifyTargetGroup_healthyThresholdCount
- The number of consecutive health checks successes required before
considering an unhealthy target healthy.
ModifyTargetGroup
, modifyTargetGroup_matcher
- [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking
for a successful response from a target. For target groups with a
protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target
groups with a protocol of HTTP or HTTPS, the range is 200-499. For
target groups with a protocol of GENEVE, the range is 200-399.
ModifyTargetGroup
, modifyTargetGroup_unhealthyThresholdCount
- The number of consecutive health check failures required before
considering the target unhealthy.
ModifyTargetGroup
, modifyTargetGroup_targetGroupArn
- The Amazon Resource Name (ARN) of the target group.
Request Lenses
modifyTargetGroup_healthCheckEnabled :: Lens' ModifyTargetGroup (Maybe Bool) Source #
Indicates whether health checks are enabled.
modifyTargetGroup_healthCheckIntervalSeconds :: Lens' ModifyTargetGroup (Maybe Natural) Source #
The approximate amount of time, in seconds, between health checks of an individual target.
modifyTargetGroup_healthCheckPath :: Lens' ModifyTargetGroup (Maybe Text) Source #
- HTTP/HTTPS health checks
- The destination for health checks on the targets.
- HTTP1 or HTTP2 protocol version
- The ping path. The default is /.
- GRPC protocol version
- The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.
modifyTargetGroup_healthCheckPort :: Lens' ModifyTargetGroup (Maybe Text) Source #
The port the load balancer uses when performing health checks on targets.
modifyTargetGroup_healthCheckProtocol :: Lens' ModifyTargetGroup (Maybe ProtocolEnum) Source #
The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
modifyTargetGroup_healthCheckTimeoutSeconds :: Lens' ModifyTargetGroup (Maybe Natural) Source #
- HTTP/HTTPS health checks
- The amount of time, in seconds, during which no response means a failed health check.
modifyTargetGroup_healthyThresholdCount :: Lens' ModifyTargetGroup (Maybe Natural) Source #
The number of consecutive health checks successes required before considering an unhealthy target healthy.
modifyTargetGroup_matcher :: Lens' ModifyTargetGroup (Maybe Matcher) Source #
- HTTP/HTTPS health checks
- The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
modifyTargetGroup_unhealthyThresholdCount :: Lens' ModifyTargetGroup (Maybe Natural) Source #
The number of consecutive health check failures required before considering the target unhealthy.
modifyTargetGroup_targetGroupArn :: Lens' ModifyTargetGroup Text Source #
The Amazon Resource Name (ARN) of the target group.
Destructuring the Response
data ModifyTargetGroupResponse Source #
See: newModifyTargetGroupResponse
smart constructor.
ModifyTargetGroupResponse' | |
|
Instances
newModifyTargetGroupResponse Source #
Create a value of ModifyTargetGroupResponse
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:
ModifyTargetGroupResponse
, modifyTargetGroupResponse_targetGroups
- Information about the modified target group.
$sel:httpStatus:ModifyTargetGroupResponse'
, modifyTargetGroupResponse_httpStatus
- The response's http status code.
Response Lenses
modifyTargetGroupResponse_targetGroups :: Lens' ModifyTargetGroupResponse (Maybe [TargetGroup]) Source #
Information about the modified target group.
modifyTargetGroupResponse_httpStatus :: Lens' ModifyTargetGroupResponse Int Source #
The response's http status code.