Create Target Group
elbv2_create_target_group | R Documentation |
Creates a target group¶
Description¶
Creates a target group.
For more information, see the following:
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.
Usage¶
elbv2_create_target_group(Name, Protocol, ProtocolVersion, Port, VpcId,
HealthCheckProtocol, HealthCheckPort, HealthCheckEnabled,
HealthCheckPath, HealthCheckIntervalSeconds, HealthCheckTimeoutSeconds,
HealthyThresholdCount, UnhealthyThresholdCount, Matcher, TargetType,
Tags, IpAddressType)
Arguments¶
Name |
[required] 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. |
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. |
ProtocolVersion |
[HTTP/HTTPS protocol] The protocol version. Specify
|
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. |
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. |
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. |
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 |
HealthCheckEnabled |
Indicates whether health checks are enabled. If the target type
is |
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. |
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 |
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 |
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 5. If the target
type is |
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 2. If the target
type is |
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. |
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.
|
Tags |
The tags to assign to the target group. |
IpAddressType |
The IP address type. The default value is
|
Value¶
A list with the following syntax:
list(
TargetGroups = list(
list(
TargetGroupArn = "string",
TargetGroupName = "string",
Protocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
Port = 123,
VpcId = "string",
HealthCheckProtocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
HealthCheckPort = "string",
HealthCheckEnabled = TRUE|FALSE,
HealthCheckIntervalSeconds = 123,
HealthCheckTimeoutSeconds = 123,
HealthyThresholdCount = 123,
UnhealthyThresholdCount = 123,
HealthCheckPath = "string",
Matcher = list(
HttpCode = "string",
GrpcCode = "string"
),
LoadBalancerArns = list(
"string"
),
TargetType = "instance"|"ip"|"lambda"|"alb",
ProtocolVersion = "string",
IpAddressType = "ipv4"|"ipv6"
)
)
)
Request syntax¶
svc$create_target_group(
Name = "string",
Protocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
ProtocolVersion = "string",
Port = 123,
VpcId = "string",
HealthCheckProtocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
HealthCheckPort = "string",
HealthCheckEnabled = TRUE|FALSE,
HealthCheckPath = "string",
HealthCheckIntervalSeconds = 123,
HealthCheckTimeoutSeconds = 123,
HealthyThresholdCount = 123,
UnhealthyThresholdCount = 123,
Matcher = list(
HttpCode = "string",
GrpcCode = "string"
),
TargetType = "instance"|"ip"|"lambda"|"alb",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
IpAddressType = "ipv4"|"ipv6"
)
Examples¶
## Not run:
# This example creates a target group that you can use to route traffic to
# targets using HTTP on port 80. This target group uses the default health
# check configuration.
svc$create_target_group(
Name = "my-targets",
Port = 80L,
Protocol = "HTTP",
VpcId = "vpc-3ac0fb5f"
)
## End(Not run)