interface ApplicationTargetGroupProps

Language	Type name
.NET	`Amazon.CDK.AWS.ElasticLoadBalancingV2.ApplicationTargetGroupProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#ApplicationTargetGroupProps`
Java	`software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroupProps`
Python	`aws_cdk.aws_elasticloadbalancingv2.ApplicationTargetGroupProps`
TypeScript (source)	`aws-cdk-lib` » `aws_elasticloadbalancingv2` » `ApplicationTargetGroupProps`

Properties for defining an Application Target Group.

Example

declare const vpc: ec2.Vpc;

const tg = new elbv2.ApplicationTargetGroup(this, 'TG', {
  targetType: elbv2.TargetType.IP,
  port: 50051,
  protocol: elbv2.ApplicationProtocol.HTTP,
  protocolVersion: elbv2.ApplicationProtocolVersion.GRPC,
  healthCheck: {
    enabled: true,
    healthyGrpcCodes: '0-99',
  },
  vpc,
});

Properties

Name	Type	Description
crossZoneEnabled?	`boolean`	Indicates whether cross zone load balancing is enabled.
deregistrationDelay?	`Duration`	The amount of time for Elastic Load Balancing to wait before deregistering a target.
enableAnomalyMitigation?	`boolean`	Indicates whether anomaly mitigation is enabled.
healthCheck?	`HealthCheck`	Health check configuration.
ipAddressType?	`TargetGroupIpAddressType`	The type of IP addresses of the targets registered with the target group.
loadBalancingAlgorithmType?	`TargetGroupLoadBalancingAlgorithmType`	The load balancing algorithm to select targets for routing requests.
port?	`number`	The port on which the target receives traffic.
protocol?	`ApplicationProtocol`	The protocol used for communication with the target.
protocolVersion?	`ApplicationProtocolVersion`	The protocol version to use.
slowStart?	`Duration`	The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group.
stickinessCookieDuration?	`Duration`	The stickiness cookie expiration period.
stickinessCookieName?	`string`	The name of an application-based stickiness cookie.
targetGroupName?	`string`	The name of the target group.
targetType?	`TargetType`	The type of targets registered to this TargetGroup, either IP or Instance.
targets?	`IApplicationLoadBalancerTarget[]`	The targets to add to this target group.
vpc?	`IVpc`	The virtual private cloud (VPC).

crossZoneEnabled?

Type: boolean (optional, default: use load balancer configuration)

Indicates whether cross zone load balancing is enabled.

deregistrationDelay?

Type: Duration (optional, default: 300)

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0-3600 seconds.

enableAnomalyMitigation?

Type: boolean (optional, default: false)

Indicates whether anomaly mitigation is enabled.

Only available when loadBalancingAlgorithmType is TargetGroupLoadBalancingAlgorithmType.WEIGHTED_RANDOM

healthCheck?

Type: HealthCheck (optional, default: The default value for each property in this configuration varies depending on the target.)

Health check configuration.

ipAddressType?

Type: TargetGroupIpAddressType (optional, default: undefined - ELB defaults to IPv4)

The type of IP addresses of the targets registered with the target group.

loadBalancingAlgorithmType?

Type: TargetGroupLoadBalancingAlgorithmType (optional, default: TargetGroupLoadBalancingAlgorithmType.ROUND_ROBIN)

The load balancing algorithm to select targets for routing requests.

port?

Type: number (optional, default: Determined from protocol if known)

The port on which the target receives traffic.

This is not applicable for Lambda targets.

protocol?

Type: ApplicationProtocol (optional, default: Determined from port if known)

The protocol used for communication with the target.

This is not applicable for Lambda targets.

protocolVersion?

Type: ApplicationProtocolVersion (optional, default: ApplicationProtocolVersion.HTTP1)

The protocol version to use.

slowStart?

Type: Duration (optional, default: 0)

The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group.

The range is 30-900 seconds (15 minutes).

stickinessCookieDuration?

Type: Duration (optional, default: Stickiness is disabled)

The stickiness cookie expiration period.

Setting this value enables load balancer stickiness.

After this period, the cookie is considered stale. The minimum value is 1 second and the maximum value is 7 days (604800 seconds).

stickinessCookieName?

Type: string (optional, default: If stickinessCookieDuration is set, a load-balancer generated cookie is used. Otherwise, no stickiness is defined.)

The name of an application-based stickiness cookie.

Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.

Note: stickinessCookieName parameter depends on the presence of stickinessCookieDuration parameter. If stickinessCookieDuration is not set, stickinessCookieName will be omitted.

targetGroupName?

Type: string (optional, default: Automatically generated.)

The name of the target group.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

targetType?

Type: TargetType (optional, default: Determined automatically.)

The type of targets registered to this TargetGroup, either IP or Instance.

All targets registered into the group must be of this type. If you register targets to the TargetGroup in the CDK app, the TargetType is determined automatically.

targets?

Type: IApplicationLoadBalancerTarget[] (optional, default: No targets.)

The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing target. If you use either Instance or IPAddress as targets, all target must be of the same type.

vpc?

Type: IVpc (optional, default: undefined)

The virtual private cloud (VPC).

only if TargetType is Ip or InstanceId