AWS SDK Version 3 for .NET
API Reference

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.

To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

To delete a target group, use DeleteTargetGroup.

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticLoadBalancingV2.AmazonElasticLoadBalancingV2Request
      Amazon.ElasticLoadBalancingV2.Model.CreateTargetGroupRequest

Namespace: Amazon.ElasticLoadBalancingV2.Model
Assembly: AWSSDK.ElasticLoadBalancingV2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateTargetGroupRequest : AmazonElasticLoadBalancingV2Request
         IAmazonWebServiceRequest

The CreateTargetGroupRequest type exposes the following members

Constructors

NameDescription
Public Method CreateTargetGroupRequest()

Properties

NameTypeDescription
Public Property HealthCheckIntervalSeconds System.Int32

Gets and sets the property HealthCheckIntervalSeconds.

The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. The default is 30 seconds.

Public Property HealthCheckPath System.String

Gets and sets the property HealthCheckPath.

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Public Property HealthCheckPort System.String

Gets and sets the property HealthCheckPort.

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Public Property HealthCheckProtocol Amazon.ElasticLoadBalancingV2.ProtocolEnum

Gets and sets the property HealthCheckProtocol.

The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.

Public Property 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. For Application Load Balancers, the range is 2 to 60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.

Public Property HealthyThresholdCount System.Int32

Gets and sets the property HealthyThresholdCount.

The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.

Public Property Matcher Amazon.ElasticLoadBalancingV2.Model.Matcher

Gets and sets the property Matcher.

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.

Public Property 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.

Public Property 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.

Public Property 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 protocol is TCP.

Public Property 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. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address). The default is instance. Note that you can't specify targets for a target group using both instance IDs and IP addresses.

If the target type is ip, 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.

Public Property UnhealthyThresholdCount System.Int32

Gets and sets the property UnhealthyThresholdCount.

The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.

Public Property VpcId System.String

Gets and sets the property VpcId.

The identifier of the virtual private cloud (VPC).

Examples

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.

To create a target group


var response = client.CreateTargetGroup(new CreateTargetGroupRequest 
{
    Name = "my-targets",
    Port = 80,
    Protocol = "HTTP",
    VpcId = "vpc-3ac0fb5f"
});

List targetGroups = response.TargetGroups;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms