Class NetworkTargetGroupProps

Properties for a new Network Target Group.

Inheritance

System.Object

NetworkTargetGroupProps

Implements

INetworkTargetGroupProps

IBaseTargetGroupProps

Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2

Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll

Syntax (csharp)

public class NetworkTargetGroupProps : Object, INetworkTargetGroupProps, IBaseTargetGroupProps

Syntax (vb)

Public Class NetworkTargetGroupProps
    Inherits Object
    Implements INetworkTargetGroupProps, IBaseTargetGroupProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.ElasticLoadBalancingV2;
using Amazon.CDK;

INetworkLoadBalancerTarget networkLoadBalancerTarget;
Vpc vpc;
var networkTargetGroupProps = new NetworkTargetGroupProps {
    Port = 123,

    // the properties below are optional
    DeregistrationDelay = Duration.Minutes(30),
    HealthCheck = new HealthCheck {
        Enabled = false,
        HealthyGrpcCodes = "healthyGrpcCodes",
        HealthyHttpCodes = "healthyHttpCodes",
        HealthyThresholdCount = 123,
        Interval = Duration.Minutes(30),
        Path = "path",
        Port = "port",
        Protocol = Protocol.HTTP,
        Timeout = Duration.Minutes(30),
        UnhealthyThresholdCount = 123
    },
    PreserveClientIp = false,
    Protocol = Protocol.HTTP,
    ProxyProtocolV2 = false,
    TargetGroupName = "targetGroupName",
    Targets = new [] { networkLoadBalancerTarget },
    TargetType = TargetType.INSTANCE,
    Vpc = vpc
};

Synopsis

Constructors

NetworkTargetGroupProps()

Properties

DeregistrationDelay	The amount of time for Elastic Load Balancing to wait before deregistering a target.
HealthCheck	Health check configuration.
Port	The port on which the listener listens for requests.
PreserveClientIp	Indicates whether client IP preservation is enabled.
Protocol	Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.
ProxyProtocolV2	Indicates whether Proxy Protocol version 2 is enabled.
TargetGroupName	The name of the target group.
Targets	The targets to add to this target group.
TargetType	The type of targets registered to this TargetGroup, either IP or Instance.
Vpc	The virtual private cloud (VPC).

Constructors

NetworkTargetGroupProps()

public NetworkTargetGroupProps()

Properties

DeregistrationDelay

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

public Duration DeregistrationDelay { get; set; }

Property Value

Duration

Remarks

The range is 0-3600 seconds.

Default: 300

HealthCheck

Health check configuration.

public IHealthCheck HealthCheck { get; set; }

Property Value

IHealthCheck

Remarks

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 listener listens for requests.

public double Port { get; set; }

Property Value

System.Double

PreserveClientIp

Indicates whether client IP preservation is enabled.

public Nullable<bool> PreserveClientIp { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

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.

public Nullable<Protocol> Protocol { get; set; }

Property Value

System.Nullable<Protocol>

Remarks

Default: - TCP

ProxyProtocolV2

Indicates whether Proxy Protocol version 2 is enabled.

public Nullable<bool> ProxyProtocolV2 { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

TargetGroupName

The name of the target group.

public string TargetGroupName { get; set; }

Property Value

System.String

Remarks

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.

Targets

The targets to add to this target group.

public INetworkLoadBalancerTarget[] Targets { get; set; }

Property Value

INetworkLoadBalancerTarget[]

Remarks

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.

TargetType

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

public Nullable<TargetType> TargetType { get; set; }

Property Value

System.Nullable<TargetType>

Remarks

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

The virtual private cloud (VPC).

public IVpc Vpc { get; set; }

Property Value

IVpc

Remarks

only if TargetType is Ip or InstanceId

Default: - undefined

Implements

INetworkTargetGroupProps

IBaseTargetGroupProps