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 ModifyTargetGroup operation. Modifies the health checks used when evaluating the health state of the targets in the specified target group.

Inheritance Hierarchy

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

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

Syntax

C#
public class ModifyTargetGroupRequest : AmazonElasticLoadBalancingV2Request
         IAmazonWebServiceRequest

The ModifyTargetGroupRequest type exposes the following members

Constructors

NameDescription
Public Method ModifyTargetGroupRequest()

Properties

NameTypeDescription
Public Property HealthCheckEnabled System.Boolean

Gets and sets the property HealthCheckEnabled.

Indicates whether health checks are enabled.

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.

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

Public Property HealthCheckPort System.String

Gets and sets the property HealthCheckPort.

The port the load balancer uses when performing health checks on targets.

Public Property 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. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Public Property HealthCheckTimeoutSeconds System.Int32

Gets and sets the property HealthCheckTimeoutSeconds.

[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.

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.

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

Public Property TargetGroupArn System.String

Gets and sets the property TargetGroupArn.

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

Public Property UnhealthyThresholdCount System.Int32

Gets and sets the property UnhealthyThresholdCount.

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

Examples

This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.

To modify the health check configuration for a target group


var client = new AmazonElasticLoadBalancingV2Client();
var response = client.ModifyTargetGroup(new ModifyTargetGroupRequest 
{
    HealthCheckPort = "443",
    HealthCheckProtocol = "HTTPS",
    TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f"
});

List<TargetGroup> targetGroups = response.TargetGroups;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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