AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateTargetGroup operation. 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.
Namespace: Amazon.ElasticLoadBalancingV2.Model
Assembly: AWSSDK.ElasticLoadBalancingV2.dll
Version: 3.x.y.z
public class CreateTargetGroupRequest : AmazonElasticLoadBalancingV2Request IAmazonWebServiceRequest
The CreateTargetGroupRequest type exposes the following members
Name | Description | |
---|---|---|
CreateTargetGroupRequest() |
Name | Type | Description | |
---|---|---|---|
HealthCheckEnabled | System.Boolean |
Gets and sets the property HealthCheckEnabled.
Indicates whether health checks are enabled. If the target type is |
|
HealthCheckIntervalSeconds | System.Int32 |
Gets and sets the property 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 |
|
HealthCheckPath | System.String |
Gets and sets the property 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. |
|
HealthCheckPort | System.String |
Gets and sets the property 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 |
|
HealthCheckProtocol | Amazon.ElasticLoadBalancingV2.ProtocolEnum |
Gets and sets the property 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. |
|
HealthCheckTimeoutSeconds | System.Int32 |
Gets and sets the property 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 | System.Int32 |
Gets and sets the property 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 |
|
IpAddressType | Amazon.ElasticLoadBalancingV2.TargetGroupIpAddressTypeEnum |
Gets and sets the property IpAddressType.
The type of IP address used for this target group. The possible values are |
|
Matcher | Amazon.ElasticLoadBalancingV2.Model.Matcher |
Gets and sets the property 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. |
|
Name | System.String |
Gets and sets the property 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. |
|
Port | System.Int32 |
Gets and sets the property 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. |
|
Protocol | Amazon.ElasticLoadBalancingV2.ProtocolEnum |
Gets and sets the property 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 | System.String |
Gets and sets the property ProtocolVersion.
[HTTP/HTTPS protocol] The protocol version. Specify |
|
Tags | System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Tag> |
Gets and sets the property Tags. The tags to assign to the target group. |
|
TargetType | Amazon.ElasticLoadBalancingV2.TargetTypeEnum |
Gets and sets the property 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.
|
|
UnhealthyThresholdCount | System.Int32 |
Gets and sets the property 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 |
|
VpcId | System.String |
Gets and sets the property 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. |
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.
var client = new AmazonElasticLoadBalancingV2Client(); var response = client.CreateTargetGroup(new CreateTargetGroupRequest { Name = "my-targets", Port = 80, Protocol = "HTTP", VpcId = "vpc-3ac0fb5f" }); List<TargetGroup> targetGroups = response.TargetGroups;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5