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

Calls the Elastic Load Balancing V2 ModifyTargetGroup API operation.

Syntax

Edit-ELB2TargetGroup
-TargetGroupArn <String>
-Matcher_GrpcCode <String>
-HealthCheckEnabled <Boolean>
-HealthCheckIntervalSecond <Int32>
-HealthCheckPath <String>
-HealthCheckPort <String>
-HealthCheckProtocol <ProtocolEnum>
-HealthCheckTimeoutSecond <Int32>
-HealthyThresholdCount <Int32>
-Matcher_HttpCode <String>
-UnhealthyThresholdCount <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

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

Parameters

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?True (ByPropertyName)
-HealthCheckEnabled <Boolean>
Indicates whether health checks are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthCheckIntervalSecond <Int32>
The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.With Network Load Balancers, you can't modify this setting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthCheckIntervalSeconds
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthCheckPort <String>
The port the load balancer uses when performing health checks on targets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthCheckProtocol <ProtocolEnum>
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.With Network Load Balancers, you can't modify this setting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthCheckTimeoutSecond <Int32>
[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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthCheckTimeoutSeconds
-HealthyThresholdCount <Int32>
The number of consecutive health checks successes required before considering an unhealthy target healthy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Matcher_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Matcher_HttpCode <String>
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 and Gateway Load Balancers, this must be "200–399".Note that when using shorthand syntax, some values such as commas need to be escaped.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the TargetGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^TargetGroupArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'TargetGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticLoadBalancingV2.Model.ModifyTargetGroupResponse). Specifying the name of a property of type Amazon.ElasticLoadBalancingV2.Model.ModifyTargetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetGroupArn <String>
The Amazon Resource Name (ARN) of the target group.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-UnhealthyThresholdCount <Int32>
The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a collection of Amazon.ElasticLoadBalancingV2.Model.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.

Examples

Example 1

Edit-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970' -HealthCheckIntervalSecond 60 -HealthCheckPath '/index.html' -HealthCheckPort 8080

HealthCheckEnabled : True
HealthCheckIntervalSeconds : 60
HealthCheckPath : /index.html
HealthCheckPort : 8080
HealthCheckProtocol : HTTP
HealthCheckTimeoutSeconds : 5
HealthyThresholdCount : 5
LoadBalancerArns : {}
Matcher : Amazon.ElasticLoadBalancingV2.Model.Matcher
Port : 80
Protocol : HTTP
TargetGroupArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970
TargetGroupName : test-tg
TargetType : instance
UnhealthyThresholdCount : 2
VpcId : vpc-2cfd7000
This example modifes the properties of the specified Target Group.

Supported Version

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