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

Amazonka.ELBV2.ModifyTargetGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Constructors

ModifyTargetGroup'

Fields

healthCheckEnabled :: Maybe Bool
Indicates whether health checks are enabled.
healthCheckIntervalSeconds :: Maybe Natural
The approximate amount of time, in seconds, between health checks of an individual target.
healthCheckPath :: Maybe Text
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.
healthCheckPort :: Maybe Text
The port the load balancer uses when performing health checks on targets.
healthCheckProtocol :: Maybe ProtocolEnum
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.
healthCheckTimeoutSeconds :: Maybe Natural
HTTP/HTTPS health checks
The amount of time, in seconds, during which no response means a failed health check.
healthyThresholdCount :: Maybe Natural
The number of consecutive health checks successes required before considering an unhealthy target healthy.
matcher :: Maybe 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.
unhealthyThresholdCount :: Maybe Natural
The number of consecutive health check failures required before considering the target unhealthy.
targetGroupArn :: Text
The Amazon Resource Name (ARN) of the target group.

Instances

Instances details

ToHeaders ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods toHeaders :: ModifyTargetGroup -> [Header] #
ToPath ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods toPath :: ModifyTargetGroup -> ByteString #
ToQuery ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods toQuery :: ModifyTargetGroup -> QueryString #
AWSRequest ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Associated Types type AWSResponse ModifyTargetGroup # Methods request :: (Service -> Service) -> ModifyTargetGroup -> Request ModifyTargetGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyTargetGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyTargetGroup))) #
Generic ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Associated Types type Rep ModifyTargetGroup :: Type -> Type # Methods from :: ModifyTargetGroup -> Rep ModifyTargetGroup x # to :: Rep ModifyTargetGroup x -> ModifyTargetGroup #
Read ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods readsPrec :: Int -> ReadS ModifyTargetGroup # readList :: ReadS [ModifyTargetGroup] # readPrec :: ReadPrec ModifyTargetGroup # readListPrec :: ReadPrec [ModifyTargetGroup] #
Show ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods showsPrec :: Int -> ModifyTargetGroup -> ShowS # show :: ModifyTargetGroup -> String # showList :: [ModifyTargetGroup] -> ShowS #
NFData ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods rnf :: ModifyTargetGroup -> () #
Eq ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods (==) :: ModifyTargetGroup -> ModifyTargetGroup -> Bool # (/=) :: ModifyTargetGroup -> ModifyTargetGroup -> Bool #
Hashable ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods hashWithSalt :: Int -> ModifyTargetGroup -> Int # hash :: ModifyTargetGroup -> Int #
type AWSResponse ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup type AWSResponse ModifyTargetGroup = ModifyTargetGroupResponse
type Rep ModifyTargetGroup Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup type Rep ModifyTargetGroup = D1 ('MetaData "ModifyTargetGroup" "Amazonka.ELBV2.ModifyTargetGroup" "amazonka-elbv2-2.0-361J9F5fkBoAtGaOoJg8Ev" 'False) (C1 ('MetaCons "ModifyTargetGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "healthCheckEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: 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 Text)) :: S1 ('MetaSel ('Just "healthCheckProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolEnum))))) :: ((S1 ('MetaSel ('Just "healthCheckTimeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "healthyThresholdCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "matcher") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Matcher)) :: (S1 ('MetaSel ('Just "unhealthyThresholdCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "targetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyTargetGroup Source #

Arguments

:: Text	`ModifyTargetGroup`
-> ModifyTargetGroup

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.

Constructors

ModifyTargetGroupResponse'
Fields targetGroups :: Maybe [TargetGroup] Information about the modified target group. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyTargetGroupResponse Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Associated Types type Rep ModifyTargetGroupResponse :: Type -> Type # Methods from :: ModifyTargetGroupResponse -> Rep ModifyTargetGroupResponse x # to :: Rep ModifyTargetGroupResponse x -> ModifyTargetGroupResponse #
Read ModifyTargetGroupResponse Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods readsPrec :: Int -> ReadS ModifyTargetGroupResponse # readList :: ReadS [ModifyTargetGroupResponse] # readPrec :: ReadPrec ModifyTargetGroupResponse # readListPrec :: ReadPrec [ModifyTargetGroupResponse] #
Show ModifyTargetGroupResponse Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods showsPrec :: Int -> ModifyTargetGroupResponse -> ShowS # show :: ModifyTargetGroupResponse -> String # showList :: [ModifyTargetGroupResponse] -> ShowS #
NFData ModifyTargetGroupResponse Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods rnf :: ModifyTargetGroupResponse -> () #
Eq ModifyTargetGroupResponse Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup Methods (==) :: ModifyTargetGroupResponse -> ModifyTargetGroupResponse -> Bool # (/=) :: ModifyTargetGroupResponse -> ModifyTargetGroupResponse -> Bool #
type Rep ModifyTargetGroupResponse Source #
Instance details Defined in Amazonka.ELBV2.ModifyTargetGroup type Rep ModifyTargetGroupResponse = D1 ('MetaData "ModifyTargetGroupResponse" "Amazonka.ELBV2.ModifyTargetGroup" "amazonka-elbv2-2.0-361J9F5fkBoAtGaOoJg8Ev" 'False) (C1 ('MetaCons "ModifyTargetGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TargetGroup])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyTargetGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifyTargetGroupResponse'`
-> ModifyTargetGroupResponse

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.