| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AutoScaling.DescribeLoadBalancerTargetGroups
Description
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the State
element in the response. When you attach a target group to an Auto
Scaling group, the initial State value is Adding. The state
transitions to Added after all Auto Scaling instances are registered
with the target group. If Elastic Load Balancing health checks are
enabled for the Auto Scaling group, the state transitions to InService
after at least one Auto Scaling instance passes the health check. When
the target group is in the InService state, Amazon EC2 Auto Scaling
can terminate and replace any instances that are reported as unhealthy.
If no registered instances pass the health checks, the target group
doesn't enter the InService state.
Target groups also have an InService state if you attach them in the
CreateAutoScalingGroup API call. If your target group state is
InService, but it is not working properly, check the scaling
activities by calling DescribeScalingActivities and take any corrective
actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This operation returns paginated results.
Synopsis
- data DescribeLoadBalancerTargetGroups = DescribeLoadBalancerTargetGroups' {}
- newDescribeLoadBalancerTargetGroups :: Text -> DescribeLoadBalancerTargetGroups
- describeLoadBalancerTargetGroups_maxRecords :: Lens' DescribeLoadBalancerTargetGroups (Maybe Int)
- describeLoadBalancerTargetGroups_nextToken :: Lens' DescribeLoadBalancerTargetGroups (Maybe Text)
- describeLoadBalancerTargetGroups_autoScalingGroupName :: Lens' DescribeLoadBalancerTargetGroups Text
- data DescribeLoadBalancerTargetGroupsResponse = DescribeLoadBalancerTargetGroupsResponse' {}
- newDescribeLoadBalancerTargetGroupsResponse :: Int -> DescribeLoadBalancerTargetGroupsResponse
- describeLoadBalancerTargetGroupsResponse_loadBalancerTargetGroups :: Lens' DescribeLoadBalancerTargetGroupsResponse (Maybe [LoadBalancerTargetGroupState])
- describeLoadBalancerTargetGroupsResponse_nextToken :: Lens' DescribeLoadBalancerTargetGroupsResponse (Maybe Text)
- describeLoadBalancerTargetGroupsResponse_httpStatus :: Lens' DescribeLoadBalancerTargetGroupsResponse Int
Creating a Request
data DescribeLoadBalancerTargetGroups Source #
See: newDescribeLoadBalancerTargetGroups smart constructor.
Constructors
| DescribeLoadBalancerTargetGroups' | |
Fields
| |
Instances
newDescribeLoadBalancerTargetGroups Source #
Create a value of DescribeLoadBalancerTargetGroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxRecords:DescribeLoadBalancerTargetGroups', describeLoadBalancerTargetGroups_maxRecords - The maximum number of items to return with this call. The default value
is 100 and the maximum value is 100.
DescribeLoadBalancerTargetGroups, describeLoadBalancerTargetGroups_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
DescribeLoadBalancerTargetGroups, describeLoadBalancerTargetGroups_autoScalingGroupName - The name of the Auto Scaling group.
Request Lenses
describeLoadBalancerTargetGroups_maxRecords :: Lens' DescribeLoadBalancerTargetGroups (Maybe Int) Source #
The maximum number of items to return with this call. The default value
is 100 and the maximum value is 100.
describeLoadBalancerTargetGroups_nextToken :: Lens' DescribeLoadBalancerTargetGroups (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeLoadBalancerTargetGroups_autoScalingGroupName :: Lens' DescribeLoadBalancerTargetGroups Text Source #
The name of the Auto Scaling group.
Destructuring the Response
data DescribeLoadBalancerTargetGroupsResponse Source #
See: newDescribeLoadBalancerTargetGroupsResponse smart constructor.
Constructors
| DescribeLoadBalancerTargetGroupsResponse' | |
Fields
| |
Instances
newDescribeLoadBalancerTargetGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeLoadBalancerTargetGroupsResponse |
Create a value of DescribeLoadBalancerTargetGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loadBalancerTargetGroups:DescribeLoadBalancerTargetGroupsResponse', describeLoadBalancerTargetGroupsResponse_loadBalancerTargetGroups - Information about the target groups.
DescribeLoadBalancerTargetGroups, describeLoadBalancerTargetGroupsResponse_nextToken - A string that indicates that the response contains more items than can
be returned in a single response. To receive additional items, specify
this string for the NextToken value when requesting the next set of
items. This value is null when there are no more items to return.
$sel:httpStatus:DescribeLoadBalancerTargetGroupsResponse', describeLoadBalancerTargetGroupsResponse_httpStatus - The response's http status code.
Response Lenses
describeLoadBalancerTargetGroupsResponse_loadBalancerTargetGroups :: Lens' DescribeLoadBalancerTargetGroupsResponse (Maybe [LoadBalancerTargetGroupState]) Source #
Information about the target groups.
describeLoadBalancerTargetGroupsResponse_nextToken :: Lens' DescribeLoadBalancerTargetGroupsResponse (Maybe Text) Source #
A string that indicates that the response contains more items than can
be returned in a single response. To receive additional items, specify
this string for the NextToken value when requesting the next set of
items. This value is null when there are no more items to return.
describeLoadBalancerTargetGroupsResponse_httpStatus :: Lens' DescribeLoadBalancerTargetGroupsResponse Int Source #
The response's http status code.