modify-target-group¶

Description¶

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

To monitor the health of the targets, use DescribeTargetHealth .

Synopsis¶

  modify-target-group
--target-group-arn <value>
[--health-check-protocol <value>]
[--health-check-port <value>]
[--health-check-path <value>]
[--health-check-enabled | --no-health-check-enabled]
[--health-check-interval-seconds <value>]
[--health-check-timeout-seconds <value>]
[--healthy-threshold-count <value>]
[--unhealthy-threshold-count <value>]
[--matcher <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--target-group-arn (string)

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

--health-check-protocol (string)

The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

With Network Load Balancers, you can’t modify this setting.

Possible values:

HTTP

HTTPS

TCP

TLS

UDP

TCP_UDP

--health-check-port (string)

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

--health-check-path (string)

[HTTP/HTTPS health checks] The ping path that is the destination for the health check request.

--health-check-enabled | --no-health-check-enabled (boolean)

Indicates whether health checks are enabled.

--health-check-interval-seconds (integer)

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.

With Network Load Balancers, you can’t modify this setting.

--health-check-timeout-seconds (integer)

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

With Network Load Balancers, you can’t modify this setting.

--healthy-threshold-count (integer)

The number of consecutive health checks successes required before considering an unhealthy target healthy.

--unhealthy-threshold-count (integer)

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

--matcher (structure)

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

With Network Load Balancers, you can’t modify this setting.

HttpCode -> (string)

The HTTP codes.

For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).

For Network Load Balancers, this is 200–399.

Shorthand Syntax:

HttpCode=string

JSON Syntax:

{
  "HttpCode": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To modify the health check configuration for a target group

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

Command:

aws elbv2 modify-target-group --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f --health-check-protocol HTTPS --health-check-port 443

Output:

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

Output¶

TargetGroups -> (list)

Information about the modified target group.

(structure)

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

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 the health check request.

Matcher -> (structure)

The HTTP codes to use when checking for a successful response from a target.

HttpCode -> (string)

The HTTP codes.

For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).

For Network Load Balancers, this is 200–399.

LoadBalancerArns -> (list)

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

(string)

TargetType -> (string)

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).

Table of Contents

Feedback

User Guide