ElasticLoadBalancingv2 / Client / modify_target_group

modify_target_group#

ElasticLoadBalancingv2.Client.modify_target_group(**kwargs)#

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

Request Syntax

response = client.modify_target_group(
    TargetGroupArn='string',
    HealthCheckProtocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
    HealthCheckPort='string',
    HealthCheckPath='string',
    HealthCheckEnabled=True|False,
    HealthCheckIntervalSeconds=123,
    HealthCheckTimeoutSeconds=123,
    HealthyThresholdCount=123,
    UnhealthyThresholdCount=123,
    Matcher={
        'HttpCode': 'string',
        'GrpcCode': 'string'
    }
)

Parameters:

TargetGroupArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the target group.
HealthCheckProtocol (string) – 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.
HealthCheckPort (string) – The port the load balancer uses when performing health checks on targets.
HealthCheckPath (string) –
[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.
HealthCheckEnabled (boolean) – Indicates whether health checks are enabled.
HealthCheckIntervalSeconds (integer) – The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) – [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) – The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) – The number of consecutive health check failures required before considering the target unhealthy.
Matcher (dict) –
[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.
- HttpCode (string) –
  
  For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
  
  For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
  
  For Gateway Load Balancers, this must be “200–399”.
  
  Note that when using shorthand syntax, some values such as commas need to be escaped.
- GrpcCode (string) –
  
  You can specify values between 0 and 99. You can specify multiple values (for example, “0,1”) or a range of values (for example, “0-5”). The default value is 12.

Return type:

dict

Returns:

Response Syntax

{
    'TargetGroups': [
        {
            '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': {
                'HttpCode': 'string',
                'GrpcCode': 'string'
            },
            'LoadBalancerArns': [
                'string',
            ],
            'TargetType': 'instance'|'ip'|'lambda'|'alb',
            'ProtocolVersion': 'string',
            'IpAddressType': 'ipv4'|'ipv6'
        },
    ]
}

Response Structure

(dict) –
- TargetGroups (list) –
  
  Information about the modified target group.
  - (dict) –
    
    Information about a target group.
    - TargetGroupArn (string) –
      
      The Amazon Resource Name (ARN) of the target group.
    - TargetGroupName (string) –
      
      The name of the target group.
    - Protocol (string) –
      
      The protocol to use for routing traffic to the targets.
    - Port (integer) –
      
      The port on which the targets are listening. This parameter is not used if the target is a Lambda function.
    - VpcId (string) –
      
      The ID of the VPC for the targets.
    - HealthCheckProtocol (string) –
      
      The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
    - HealthCheckPort (string) –
      
      The port to use to connect with the target.
    - HealthCheckEnabled (boolean) –
      
      Indicates whether health checks are enabled.
    - HealthCheckIntervalSeconds (integer) –
      
      The approximate amount of time, in seconds, between health checks of an individual target.
    - HealthCheckTimeoutSeconds (integer) –
      
      The amount of time, in seconds, during which no response means a failed health check.
    - HealthyThresholdCount (integer) –
      
      The number of consecutive health checks successes required before considering an unhealthy target healthy.
    - UnhealthyThresholdCount (integer) –
      
      The number of consecutive health check failures required before considering the target unhealthy.
    - HealthCheckPath (string) –
      
      The destination for health checks on the targets.
    - Matcher (dict) –
      
      The HTTP or gRPC codes to use when checking for a successful response from a target.
      - HttpCode (string) –
        
        For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
        
        For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
        
        For Gateway Load Balancers, this must be “200–399”.
        
        Note that when using shorthand syntax, some values such as commas need to be escaped.
      - GrpcCode (string) –
        
        You can specify values between 0 and 99. You can specify multiple values (for example, “0,1”) or a range of values (for example, “0-5”). The default value is 12.
    - LoadBalancerArns (list) –
      
      The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.
      - (string) –
    - TargetType (string) –
      
      The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).
    - ProtocolVersion (string) –
      
      [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
    - IpAddressType (string) –
      
      The IP address type. The default value is ipv4.

Exceptions

ElasticLoadBalancingv2.Client.exceptions.TargetGroupNotFoundException
ElasticLoadBalancingv2.Client.exceptions.InvalidConfigurationRequestException

Examples

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

response = client.modify_target_group(
    HealthCheckPort='443',
    HealthCheckProtocol='HTTPS',
    TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f',
)

print(response)

Expected Output:

{
    'TargetGroups': [
        {
            'HealthCheckIntervalSeconds': 30,
            'HealthCheckPort': '443',
            'HealthCheckProtocol': 'HTTPS',
            'HealthCheckTimeoutSeconds': 5,
            'HealthyThresholdCount': 5,
            'LoadBalancerArns': [
                'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            ],
            'Matcher': {
                'HttpCode': '200',
            },
            'Port': 443,
            'Protocol': 'HTTPS',
            'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f',
            'TargetGroupName': 'my-https-targets',
            'UnhealthyThresholdCount': 2,
            'VpcId': 'vpc-3ac0fb5f',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}