Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-elasticloadbalancingv2-targetgroup.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup. Source:- No source definition found, add manually please

Properties

IpAddressType string | Aws_CF_FunctionString

The type of IP address used for this target group. The possible values are ipv4 and ipv6.

HealthCheckIntervalSeconds integer

The approximate amount of time, in seconds, between health checks of an individual target.

Matcher object
2 nested properties
GrpcCode string | Aws_CF_FunctionString

You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.

HttpCode string | Aws_CF_FunctionString

For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.

HealthCheckPath string | Aws_CF_FunctionString

[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 /AWS.ALB/healthcheck.

Port integer

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.

The targets.

uniqueItems=true
HealthCheckEnabled boolean

Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.

ProtocolVersion string | Aws_CF_FunctionString

[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

UnhealthyThresholdCount integer

The number of consecutive health check failures required before considering a target unhealthy.

HealthCheckTimeoutSeconds integer

The amount of time, in seconds, during which no response from a target means a failed health check.

Name string | Aws_CF_FunctionString

The name of the target group.

VpcId string | Aws_CF_FunctionString

The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.

HealthyThresholdCount integer

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

HealthCheckProtocol string | Aws_CF_FunctionString

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

TargetGroupAttributes TargetGroupAttribute[]

The attributes.

uniqueItems=true
TargetType string | Aws_CF_FunctionString

The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.

HealthCheckPort string | Aws_CF_FunctionString

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

Protocol string | Aws_CF_FunctionString

The protocol to use for routing traffic to the targets.

Tags Tag[]

The tags.

Definitions

Matcher object
GrpcCode string | Aws_CF_FunctionString

You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.

HttpCode string | Aws_CF_FunctionString

For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.

TargetDescription object
Id string | Aws_CF_FunctionString required

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.

AvailabilityZone string | Aws_CF_FunctionString

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

Port integer

The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.

TargetGroupAttribute object
Value string | Aws_CF_FunctionString

The name of the attribute.

Key string | Aws_CF_FunctionString

The value of the attribute.

Tag object
Value string | Aws_CF_FunctionString required

The key name of the tag.

Key string | Aws_CF_FunctionString required

The value for the tag.