AWS Tools for Windows PowerShell
Command 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.

Synopsis

Invokes the ModifyTargetGroup operation against Elastic Load Balancing V2.

Syntax

Edit-ELB2TargetGroup
-TargetGroupArn <String>
-HealthCheckIntervalSecond <Int32>
-HealthCheckPath <String>
-HealthCheckPort <String>
-HealthCheckProtocol <ProtocolEnum>
-HealthCheckTimeoutSecond <Int32>
-HealthyThresholdCount <Int32>
-Matcher_HttpCode <String>
-UnhealthyThresholdCount <Int32>
-Force <SwitchParameter>

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.

Parameters

-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckIntervalSecond <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckPath <String>
[HTTP/HTTPS health checks] The ping path that is the destination for the health check request.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckPort <String>
The port the load balancer uses when performing health checks on targets.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckProtocol <ProtocolEnum>
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.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckTimeoutSecond <Int32>
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
Required?False
Position?Named
Accept pipeline input?False
-HealthyThresholdCount <Int32>
The number of consecutive health checks successes required before considering an unhealthy target healthy.
Required?False
Position?Named
Accept pipeline input?False
-Matcher_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 to 399.
Required?False
Position?Named
Accept pipeline input?False
-TargetGroupArn <String>
The Amazon Resource Name (ARN) of the target group.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-UnhealthyThresholdCount <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the TargetGroupArn parameter.

Outputs

This cmdlet returns a collection of TargetGroup objects. The service call response (type Amazon.ElasticLoadBalancingV2.Model.ModifyTargetGroupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z