2.170.0

interface NetworkTargetGroupProps

LanguageType name
.NETAmazon.CDK.AWS.ElasticLoadBalancingV2.NetworkTargetGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#NetworkTargetGroupProps
Javasoftware.amazon.awscdk.services.elasticloadbalancingv2.NetworkTargetGroupProps
Pythonaws_cdk.aws_elasticloadbalancingv2.NetworkTargetGroupProps
TypeScript (source)aws-cdk-lib » aws_elasticloadbalancingv2 » NetworkTargetGroupProps

Properties for a new Network Target Group.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';

declare const networkLoadBalancerTarget: elbv2.INetworkLoadBalancerTarget;
declare const vpc: ec2.Vpc;
const networkTargetGroupProps: elbv2.NetworkTargetGroupProps = {
  port: 123,

  // the properties below are optional
  connectionTermination: false,
  crossZoneEnabled: false,
  deregistrationDelay: cdk.Duration.minutes(30),
  healthCheck: {
    enabled: false,
    healthyGrpcCodes: 'healthyGrpcCodes',
    healthyHttpCodes: 'healthyHttpCodes',
    healthyThresholdCount: 123,
    interval: cdk.Duration.minutes(30),
    path: 'path',
    port: 'port',
    protocol: elbv2.Protocol.HTTP,
    timeout: cdk.Duration.minutes(30),
    unhealthyThresholdCount: 123,
  },
  preserveClientIp: false,
  protocol: elbv2.Protocol.HTTP,
  proxyProtocolV2: false,
  targetGroupName: 'targetGroupName',
  targets: [networkLoadBalancerTarget],
  targetType: elbv2.TargetType.INSTANCE,
  vpc: vpc,
};

Properties

NameTypeDescription
portnumberThe port on which the target receives traffic.
connectionTermination?booleanIndicates whether the load balancer terminates connections at the end of the deregistration timeout.
crossZoneEnabled?booleanIndicates whether cross zone load balancing is enabled.
deregistrationDelay?DurationThe amount of time for Elastic Load Balancing to wait before deregistering a target.
healthCheck?HealthCheckHealth check configuration.
preserveClientIp?booleanIndicates whether client IP preservation is enabled.
protocol?ProtocolProtocol for target group, expects TCP, TLS, UDP, or TCP_UDP.
proxyProtocolV2?booleanIndicates whether Proxy Protocol version 2 is enabled.
targetGroupName?stringThe name of the target group.
targetType?TargetTypeThe type of targets registered to this TargetGroup, either IP or Instance.
targets?INetworkLoadBalancerTarget[]The targets to add to this target group.
vpc?IVpcThe virtual private cloud (VPC).

port

Type: number

The port on which the target receives traffic.

connectionTermination?

Type: boolean (optional, default: false)

Indicates whether the load balancer terminates connections at the end of the deregistration timeout.

crossZoneEnabled?

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

Indicates whether cross zone load balancing is enabled.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html

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.

healthCheck?

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

Health check configuration.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties

preserveClientIp?

Type: boolean (optional, default: false if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, true.)

Indicates whether client IP preservation is enabled.

protocol?

Type: Protocol (optional, default: TCP)

Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.

proxyProtocolV2?

Type: boolean (optional, default: false)

Indicates whether Proxy Protocol version 2 is enabled.

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: INetworkLoadBalancerTarget[] (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

← PreviousNext →