Skip to content
This repository was archived by the owner on Jun 5, 2020. It is now read-only.

Latest commit

 

History

History
69 lines (57 loc) · 5.58 KB

aws_target_group.md

File metadata and controls

69 lines (57 loc) · 5.58 KB

Document: "elasticloadbalancingv2"

Path: "https://github.com/aws/aws-sdk-go-v2/tree/master/models/apis/elasticloadbalancingv2/2015-12-01/api-2.json")

TargetGroup

aws_target_group {
  health_check_enabled => $aws_health_check_enabled
  health_check_interval_seconds => "HealthCheckIntervalSeconds (optional)",
  health_check_path => $aws_path
  health_check_port => $aws_health_check_port
  health_check_protocol => $aws_protocol_enum
  health_check_timeout_seconds => "HealthCheckTimeoutSeconds (optional)",
  healthy_threshold_count => $aws_health_check_threshold_count
  load_balancer_arn => $aws_load_balancer_arn
  matcher => $aws_matcher
  name => $aws_target_group_name
  names => "Names (optional)",
  page_size => $aws_page_size
  port => $aws_port
  protocol => $aws_protocol_enum
  target_group_arn => $aws_target_group_arn
  target_group_arns => "TargetGroupArns (optional)",
  target_type => $aws_target_type_enum
  unhealthy_threshold_count => $aws_health_check_threshold_count
  vpc_id => $aws_vpc_id
}
Name Type Required
health_check_enabled HealthCheckEnabled false
health_check_interval_seconds HealthCheckIntervalSeconds false
health_check_path Path false
health_check_port HealthCheckPort false
health_check_protocol ProtocolEnum false
health_check_timeout_seconds HealthCheckTimeoutSeconds false
healthy_threshold_count HealthCheckThresholdCount false
load_balancer_arn LoadBalancerArn false
matcher Matcher false
name TargetGroupName false
names TargetGroupNames false
page_size PageSize false
port Port false
protocol ProtocolEnum false
target_group_arn TargetGroupArn false
target_group_arns TargetGroupArns false
target_type TargetTypeEnum false
unhealthy_threshold_count HealthCheckThresholdCount false
vpc_id VpcId false

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the TargetGroup

Operation Path Verb Description OperationID
Create / POST

Creates a target group.

To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

To delete a target group, use DeleteTargetGroup.

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

CreateTargetGroup
List - list all / POST

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

DescribeTargetGroups
List - get one ``
List - get list using params / POST

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

DescribeTargetGroups
Update / POST

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.

ModifyTargetGroup
Delete / POST

Deletes the specified target group.

You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.

DeleteTargetGroup