Amazonka.ELBV2.Types.TargetGroup

Documentation

data TargetGroup

Information about a target group.

See: newTargetGroup smart constructor.

Constructors

TargetGroup'

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

  The destination for health checks on the targets.

• healthCheckPort :: Maybe Text

  The port to use to connect with the target.

• healthCheckProtocol :: Maybe ProtocolEnum

  The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

• healthCheckTimeoutSeconds :: Maybe Natural

  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.

• ipAddressType :: Maybe TargetGroupIpAddressTypeEnum

  The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

• loadBalancerArns :: Maybe [Text]

  The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

• matcher :: Maybe Matcher

  The HTTP or gRPC codes to use when checking for a successful response from a target.

• port :: Maybe Natural

  The port on which the targets are listening. Not used if the target is a Lambda function.

• protocol :: Maybe ProtocolEnum

  The protocol to use for routing traffic to the targets.

• protocolVersion :: Maybe Text

  HTTP/HTTPS protocol

  The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

• targetGroupArn :: Maybe Text

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

• targetGroupName :: Maybe Text

  The name of the target group.

• targetType :: Maybe TargetTypeEnum

  The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

• unhealthyThresholdCount :: Maybe Natural

  The number of consecutive health check failures required before considering the target unhealthy.

• vpcId :: Maybe Text

  The ID of the VPC for the targets.

Instances

FromXML TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

Methods

parseXML :: [Node] -> Either String TargetGroup

Generic TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

Associated Types

type Rep TargetGroup :: Type -> Type

Methods

from :: TargetGroup -> Rep TargetGroup x

to :: Rep TargetGroup x -> TargetGroup

Read TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

Methods

readsPrec :: Int -> ReadS TargetGroup

readList :: ReadS [TargetGroup]

readPrec :: ReadPrec TargetGroup

readListPrec :: ReadPrec [TargetGroup]

Show TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

Methods

showsPrec :: Int -> TargetGroup -> ShowS

show :: TargetGroup -> String

showList :: [TargetGroup] -> ShowS

NFData TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

Methods

rnf :: TargetGroup -> ()

Eq TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

Methods

(==) :: TargetGroup -> TargetGroup -> Bool

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

Hashable TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

Methods

hashWithSalt :: Int -> TargetGroup -> Int

hash :: TargetGroup -> Int

type Rep TargetGroup

Defined in Amazonka.ELBV2.Types.TargetGroup

type Rep TargetGroup = D1 ('MetaData "TargetGroup" "Amazonka.ELBV2.Types.TargetGroup" "amazonka-elbv2-2.0-361J9F5fkBoAtGaOoJg8Ev" 'False) (C1 ('MetaCons "TargetGroup'" '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 "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetGroupIpAddressTypeEnum)) :*: S1 ('MetaSel ('Just "loadBalancerArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :*: (((S1 ('MetaSel ('Just "matcher") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Matcher)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolEnum)) :*: S1 ('MetaSel ('Just "protocolVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "targetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetTypeEnum)) :*: (S1 ('MetaSel ('Just "unhealthyThresholdCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newTargetGroup :: TargetGroup

Create a value of TargetGroup 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:healthCheckEnabled:TargetGroup', targetGroup_healthCheckEnabled - Indicates whether health checks are enabled.

$sel:healthCheckIntervalSeconds:TargetGroup', targetGroup_healthCheckIntervalSeconds - The approximate amount of time, in seconds, between health checks of an individual target.

$sel:healthCheckPath:TargetGroup', targetGroup_healthCheckPath - The destination for health checks on the targets.

$sel:healthCheckPort:TargetGroup', targetGroup_healthCheckPort - The port to use to connect with the target.

$sel:healthCheckProtocol:TargetGroup', targetGroup_healthCheckProtocol - The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

$sel:healthCheckTimeoutSeconds:TargetGroup', targetGroup_healthCheckTimeoutSeconds - The amount of time, in seconds, during which no response means a failed health check.

$sel:healthyThresholdCount:TargetGroup', targetGroup_healthyThresholdCount - The number of consecutive health checks successes required before considering an unhealthy target healthy.

$sel:ipAddressType:TargetGroup', targetGroup_ipAddressType - The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

$sel:loadBalancerArns:TargetGroup', targetGroup_loadBalancerArns - The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

$sel:matcher:TargetGroup', targetGroup_matcher - The HTTP or gRPC codes to use when checking for a successful response from a target.

$sel:port:TargetGroup', targetGroup_port - The port on which the targets are listening. Not used if the target is a Lambda function.

$sel:protocol:TargetGroup', targetGroup_protocol - The protocol to use for routing traffic to the targets.

$sel:protocolVersion:TargetGroup', targetGroup_protocolVersion - [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

$sel:targetGroupArn:TargetGroup', targetGroup_targetGroupArn - The Amazon Resource Name (ARN) of the target group.

$sel:targetGroupName:TargetGroup', targetGroup_targetGroupName - The name of the target group.

$sel:targetType:TargetGroup', targetGroup_targetType - The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

$sel:unhealthyThresholdCount:TargetGroup', targetGroup_unhealthyThresholdCount - The number of consecutive health check failures required before considering the target unhealthy.

$sel:vpcId:TargetGroup', targetGroup_vpcId - The ID of the VPC for the targets.

targetGroup_healthCheckEnabled :: Lens' TargetGroup (Maybe Bool)

Indicates whether health checks are enabled.

targetGroup_healthCheckIntervalSeconds :: Lens' TargetGroup (Maybe Natural)

The approximate amount of time, in seconds, between health checks of an individual target.

targetGroup_healthCheckPath :: Lens' TargetGroup (Maybe Text)

The destination for health checks on the targets.

targetGroup_healthCheckPort :: Lens' TargetGroup (Maybe Text)

The port to use to connect with the target.

targetGroup_healthCheckProtocol :: Lens' TargetGroup (Maybe ProtocolEnum)

The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

targetGroup_healthCheckTimeoutSeconds :: Lens' TargetGroup (Maybe Natural)

The amount of time, in seconds, during which no response means a failed health check.

targetGroup_healthyThresholdCount :: Lens' TargetGroup (Maybe Natural)

The number of consecutive health checks successes required before considering an unhealthy target healthy.

targetGroup_ipAddressType :: Lens' TargetGroup (Maybe TargetGroupIpAddressTypeEnum)

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

targetGroup_loadBalancerArns :: Lens' TargetGroup (Maybe [Text])

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

targetGroup_matcher :: Lens' TargetGroup (Maybe Matcher)

The HTTP or gRPC codes to use when checking for a successful response from a target.

targetGroup_port :: Lens' TargetGroup (Maybe Natural)

The port on which the targets are listening. Not used if the target is a Lambda function.

targetGroup_protocol :: Lens' TargetGroup (Maybe ProtocolEnum)

The protocol to use for routing traffic to the targets.

targetGroup_protocolVersion :: Lens' TargetGroup (Maybe Text)

HTTP/HTTPS protocol

The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

targetGroup_targetGroupArn :: Lens' TargetGroup (Maybe Text)

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

targetGroup_targetGroupName :: Lens' TargetGroup (Maybe Text)

The name of the target group.

targetGroup_targetType :: Lens' TargetGroup (Maybe TargetTypeEnum)

The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

targetGroup_unhealthyThresholdCount :: Lens' TargetGroup (Maybe Natural)

The number of consecutive health check failures required before considering the target unhealthy.

targetGroup_vpcId :: Lens' TargetGroup (Maybe Text)

The ID of the VPC for the targets.