NetworkTargetGroupProps

class aws_cdk.aws_elasticloadbalancingv2.NetworkTargetGroupProps(*, cross_zone_enabled=None, deregistration_delay=None, health_check=None, target_group_name=None, target_type=None, vpc=None, port, connection_termination=None, preserve_client_ip=None, protocol=None, proxy_protocol_v2=None, targets=None)

Bases: BaseTargetGroupProps

Properties for a new Network Target Group.

Parameters:

cross_zone_enabled (Optional[bool]) – Indicates whether cross zone load balancing is enabled. Default: - use load balancer configuration
deregistration_delay (Optional[Duration]) – The amount of time for Elastic Load Balancing to wait before deregistering a target. The range is 0-3600 seconds. Default: 300
health_check (Union[HealthCheck, Dict[str, Any], None]) – Health check configuration. Default: - The default value for each property in this configuration varies depending on the target.
target_group_name (Optional[str]) – 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. Default: - Automatically generated.
target_type (Optional[TargetType]) – 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. Default: - Determined automatically.
vpc (Optional[IVpc]) – The virtual private cloud (VPC). only if TargetType is Ip or InstanceId Default: - undefined
port (Union[int, float]) – The port on which the target receives traffic.
connection_termination (Optional[bool]) – Indicates whether the load balancer terminates connections at the end of the deregistration timeout. Default: false
preserve_client_ip (Optional[bool]) – Indicates whether client IP preservation is enabled. Default: false if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, true.
protocol (Optional[Protocol]) – Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP. Default: - TCP
proxy_protocol_v2 (Optional[bool]) – Indicates whether Proxy Protocol version 2 is enabled. Default: false
targets (Optional[Sequence[INetworkLoadBalancerTarget]]) – 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. Default: - No targets.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_elasticloadbalancingv2 as elbv2

# network_load_balancer_target: elbv2.INetworkLoadBalancerTarget
# vpc: ec2.Vpc

network_target_group_props = elbv2.NetworkTargetGroupProps(
    port=123,

    # the properties below are optional
    connection_termination=False,
    cross_zone_enabled=False,
    deregistration_delay=cdk.Duration.minutes(30),
    health_check=elbv2.HealthCheck(
        enabled=False,
        healthy_grpc_codes="healthyGrpcCodes",
        healthy_http_codes="healthyHttpCodes",
        healthy_threshold_count=123,
        interval=cdk.Duration.minutes(30),
        path="path",
        port="port",
        protocol=elbv2.Protocol.HTTP,
        timeout=cdk.Duration.minutes(30),
        unhealthy_threshold_count=123
    ),
    preserve_client_ip=False,
    protocol=elbv2.Protocol.HTTP,
    proxy_protocol_v2=False,
    target_group_name="targetGroupName",
    targets=[network_load_balancer_target],
    target_type=elbv2.TargetType.INSTANCE,
    vpc=vpc
)

Attributes

connection_termination

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

Default:: false

cross_zone_enabled

Indicates whether cross zone load balancing is enabled.

Default:

use load balancer configuration

See:

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

deregistration_delay

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

The range is 0-3600 seconds.

Default:: 300

health_check

Health check configuration.

Default:

The default value for each property in this configuration varies depending on the target.

See:

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

port: The port on which the target receives traffic.

preserve_client_ip

Indicates whether client IP preservation is enabled.

Default:

false if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, true.

protocol

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

Default:

TCP

proxy_protocol_v2

Indicates whether Proxy Protocol version 2 is enabled.

Default:: false

target_group_name

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.

Default:

Automatically generated.

target_type

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.

Default:

Determined automatically.

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.

Default:

No targets.

vpc

The virtual private cloud (VPC).

only if TargetType is Ip or InstanceId

Default:

undefined