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 |
Creates a target group.
For more information, see the following:
- Target groups for your Application Load Balancers
- Target groups for your Network Load Balancers
- Target groups for your Gateway Load Balancers
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
Synopsis
- data CreateTargetGroup = CreateTargetGroup' {
- healthCheckEnabled :: Maybe Bool
- healthCheckIntervalSeconds :: Maybe Natural
- healthCheckPath :: Maybe Text
- healthCheckPort :: Maybe Text
- healthCheckProtocol :: Maybe ProtocolEnum
- healthCheckTimeoutSeconds :: Maybe Natural
- healthyThresholdCount :: Maybe Natural
- ipAddressType :: Maybe TargetGroupIpAddressTypeEnum
- matcher :: Maybe Matcher
- port :: Maybe Natural
- protocol :: Maybe ProtocolEnum
- protocolVersion :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- targetType :: Maybe TargetTypeEnum
- unhealthyThresholdCount :: Maybe Natural
- vpcId :: Maybe Text
- name :: Text
- newCreateTargetGroup :: Text -> CreateTargetGroup
- createTargetGroup_healthCheckEnabled :: Lens' CreateTargetGroup (Maybe Bool)
- createTargetGroup_healthCheckIntervalSeconds :: Lens' CreateTargetGroup (Maybe Natural)
- createTargetGroup_healthCheckPath :: Lens' CreateTargetGroup (Maybe Text)
- createTargetGroup_healthCheckPort :: Lens' CreateTargetGroup (Maybe Text)
- createTargetGroup_healthCheckProtocol :: Lens' CreateTargetGroup (Maybe ProtocolEnum)
- createTargetGroup_healthCheckTimeoutSeconds :: Lens' CreateTargetGroup (Maybe Natural)
- createTargetGroup_healthyThresholdCount :: Lens' CreateTargetGroup (Maybe Natural)
- createTargetGroup_ipAddressType :: Lens' CreateTargetGroup (Maybe TargetGroupIpAddressTypeEnum)
- createTargetGroup_matcher :: Lens' CreateTargetGroup (Maybe Matcher)
- createTargetGroup_port :: Lens' CreateTargetGroup (Maybe Natural)
- createTargetGroup_protocol :: Lens' CreateTargetGroup (Maybe ProtocolEnum)
- createTargetGroup_protocolVersion :: Lens' CreateTargetGroup (Maybe Text)
- createTargetGroup_tags :: Lens' CreateTargetGroup (Maybe (NonEmpty Tag))
- createTargetGroup_targetType :: Lens' CreateTargetGroup (Maybe TargetTypeEnum)
- createTargetGroup_unhealthyThresholdCount :: Lens' CreateTargetGroup (Maybe Natural)
- createTargetGroup_vpcId :: Lens' CreateTargetGroup (Maybe Text)
- createTargetGroup_name :: Lens' CreateTargetGroup Text
- data CreateTargetGroupResponse = CreateTargetGroupResponse' {
- targetGroups :: Maybe [TargetGroup]
- httpStatus :: Int
- newCreateTargetGroupResponse :: Int -> CreateTargetGroupResponse
- createTargetGroupResponse_targetGroups :: Lens' CreateTargetGroupResponse (Maybe [TargetGroup])
- createTargetGroupResponse_httpStatus :: Lens' CreateTargetGroupResponse Int
Creating a Request
data CreateTargetGroup Source #
See: newCreateTargetGroup
smart constructor.
CreateTargetGroup' | |
|
Instances
Create a value of CreateTargetGroup
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:
CreateTargetGroup
, createTargetGroup_healthCheckEnabled
- Indicates whether health checks are enabled. If the target type is
lambda
, health checks are disabled by default but can be enabled. If
the target type is instance
, ip
, or alb
, health checks are always
enabled and cannot be disabled.
CreateTargetGroup
, createTargetGroup_healthCheckIntervalSeconds
- The approximate amount of time, in seconds, between health checks of an
individual target. The range is 5-300. If the target group protocol is
TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the
target group protocol is GENEVE, the default is 10 seconds. If the
target type is lambda
, the default is 35 seconds.
CreateTargetGroup
, createTargetGroup_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.
CreateTargetGroup
, createTargetGroup_healthCheckPort
- The port the load balancer uses when performing health checks on
targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the
default is traffic-port
, which is the port on which each target
receives traffic from the load balancer. If the protocol is GENEVE, the
default is port 80.
CreateTargetGroup
, createTargetGroup_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. The GENEVE, TLS, UDP, and TCP_UDP
protocols are not supported for health checks.
CreateTargetGroup
, createTargetGroup_healthCheckTimeoutSeconds
- The amount of time, in seconds, during which no response from a target
means a failed health check. The range is 2–120 seconds. For target
groups with a protocol of HTTP, the default is 6 seconds. For target
groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds.
For target groups with a protocol of GENEVE, the default is 5 seconds.
If the target type is lambda
, the default is 30 seconds.
CreateTargetGroup
, createTargetGroup_healthyThresholdCount
- The number of consecutive health check successes required before
considering a target healthy. The range is 2-10. If the target group
protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For
target groups with a protocol of GENEVE, the default is 3. If the target
type is lambda
, the default is 5.
CreateTargetGroup
, createTargetGroup_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
.
CreateTargetGroup
, createTargetGroup_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.
CreateTargetGroup
, createTargetGroup_port
- The port on which the targets receive traffic. This port is used unless
you specify a port override when registering the target. If the target
is a Lambda function, this parameter does not apply. If the protocol is
GENEVE, the supported port is 6081.
CreateTargetGroup
, createTargetGroup_protocol
- The protocol to use for routing traffic to the targets. For Application
Load Balancers, the supported protocols are HTTP and HTTPS. For Network
Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP.
For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP
listener must be associated with a TCP_UDP target group. If the target
is a Lambda function, this parameter does not apply.
CreateTargetGroup
, createTargetGroup_protocolVersion
- [HTTP/HTTPS protocol] The protocol version. Specify GRPC
to send
requests to targets using gRPC. Specify HTTP2
to send requests to
targets using HTTP/2. The default is HTTP1
, which sends requests to
targets using HTTP/1.1.
CreateTargetGroup
, createTargetGroup_tags
- The tags to assign to the target group.
CreateTargetGroup
, createTargetGroup_targetType
- The type of target that you must specify when registering targets with
this target group. You can't specify targets for a target group using
more than one target type.
instance
- Register targets by instance ID. This is the default value.ip
- Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.lambda
- Register a single Lambda function as a target.alb
- Register a single Application Load Balancer as a target.
CreateTargetGroup
, createTargetGroup_unhealthyThresholdCount
- The number of consecutive health check failures required before
considering a target unhealthy. The range is 2-10. If the target group
protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For
target groups with a protocol of GENEVE, the default is 3. If the target
type is lambda
, the default is 5.
CreateTargetGroup
, createTargetGroup_vpcId
- The identifier of the virtual private cloud (VPC). If the target is a
Lambda function, this parameter does not apply. Otherwise, this
parameter is required.
CreateTargetGroup
, createTargetGroup_name
- The name of the target group.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
Request Lenses
createTargetGroup_healthCheckEnabled :: Lens' CreateTargetGroup (Maybe Bool) Source #
Indicates whether health checks are enabled. If the target type is
lambda
, health checks are disabled by default but can be enabled. If
the target type is instance
, ip
, or alb
, health checks are always
enabled and cannot be disabled.
createTargetGroup_healthCheckIntervalSeconds :: Lens' CreateTargetGroup (Maybe Natural) Source #
The approximate amount of time, in seconds, between health checks of an
individual target. The range is 5-300. If the target group protocol is
TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the
target group protocol is GENEVE, the default is 10 seconds. If the
target type is lambda
, the default is 35 seconds.
createTargetGroup_healthCheckPath :: Lens' CreateTargetGroup (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.
createTargetGroup_healthCheckPort :: Lens' CreateTargetGroup (Maybe Text) Source #
The port the load balancer uses when performing health checks on
targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the
default is traffic-port
, which is the port on which each target
receives traffic from the load balancer. If the protocol is GENEVE, the
default is port 80.
createTargetGroup_healthCheckProtocol :: Lens' CreateTargetGroup (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. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
createTargetGroup_healthCheckTimeoutSeconds :: Lens' CreateTargetGroup (Maybe Natural) Source #
The amount of time, in seconds, during which no response from a target
means a failed health check. The range is 2–120 seconds. For target
groups with a protocol of HTTP, the default is 6 seconds. For target
groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds.
For target groups with a protocol of GENEVE, the default is 5 seconds.
If the target type is lambda
, the default is 30 seconds.
createTargetGroup_healthyThresholdCount :: Lens' CreateTargetGroup (Maybe Natural) Source #
The number of consecutive health check successes required before
considering a target healthy. The range is 2-10. If the target group
protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For
target groups with a protocol of GENEVE, the default is 3. If the target
type is lambda
, the default is 5.
createTargetGroup_ipAddressType :: Lens' CreateTargetGroup (Maybe TargetGroupIpAddressTypeEnum) Source #
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
.
createTargetGroup_matcher :: Lens' CreateTargetGroup (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.
createTargetGroup_port :: Lens' CreateTargetGroup (Maybe Natural) Source #
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
createTargetGroup_protocol :: Lens' CreateTargetGroup (Maybe ProtocolEnum) Source #
The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.
createTargetGroup_protocolVersion :: Lens' CreateTargetGroup (Maybe Text) Source #
- HTTP/HTTPS protocol
- The protocol version. Specify
GRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1.
createTargetGroup_tags :: Lens' CreateTargetGroup (Maybe (NonEmpty Tag)) Source #
The tags to assign to the target group.
createTargetGroup_targetType :: Lens' CreateTargetGroup (Maybe TargetTypeEnum) Source #
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
instance
- Register targets by instance ID. This is the default value.ip
- Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.lambda
- Register a single Lambda function as a target.alb
- Register a single Application Load Balancer as a target.
createTargetGroup_unhealthyThresholdCount :: Lens' CreateTargetGroup (Maybe Natural) Source #
The number of consecutive health check failures required before
considering a target unhealthy. The range is 2-10. If the target group
protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For
target groups with a protocol of GENEVE, the default is 3. If the target
type is lambda
, the default is 5.
createTargetGroup_vpcId :: Lens' CreateTargetGroup (Maybe Text) Source #
The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.
createTargetGroup_name :: Lens' CreateTargetGroup Text Source #
The name of the target group.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
Destructuring the Response
data CreateTargetGroupResponse Source #
See: newCreateTargetGroupResponse
smart constructor.
CreateTargetGroupResponse' | |
|
Instances
newCreateTargetGroupResponse Source #
Create a value of CreateTargetGroupResponse
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:
CreateTargetGroupResponse
, createTargetGroupResponse_targetGroups
- Information about the target group.
$sel:httpStatus:CreateTargetGroupResponse'
, createTargetGroupResponse_httpStatus
- The response's http status code.
Response Lenses
createTargetGroupResponse_targetGroups :: Lens' CreateTargetGroupResponse (Maybe [TargetGroup]) Source #
Information about the target group.
createTargetGroupResponse_httpStatus :: Lens' CreateTargetGroupResponse Int Source #
The response's http status code.