Class CfnTargetGroupProps
Properties for defining a CfnTargetGroup.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll
Syntax (csharp)
public class CfnTargetGroupProps : Object, ICfnTargetGroupPropsSyntax (vb)
Public Class CfnTargetGroupProps
Inherits Object
Implements ICfnTargetGroupPropsRemarks
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.ElasticLoadBalancingV2;
var cfnTargetGroupProps = new CfnTargetGroupProps {
HealthCheckEnabled = false,
HealthCheckIntervalSeconds = 123,
HealthCheckPath = "healthCheckPath",
HealthCheckPort = "healthCheckPort",
HealthCheckProtocol = "healthCheckProtocol",
HealthCheckTimeoutSeconds = 123,
HealthyThresholdCount = 123,
IpAddressType = "ipAddressType",
Matcher = new MatcherProperty {
GrpcCode = "grpcCode",
HttpCode = "httpCode"
},
Name = "name",
Port = 123,
Protocol = "protocol",
ProtocolVersion = "protocolVersion",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TargetGroupAttributes = new [] { new TargetGroupAttributeProperty {
Key = "key",
Value = "value"
} },
Targets = new [] { new TargetDescriptionProperty {
Id = "id",
// the properties below are optional
AvailabilityZone = "availabilityZone",
Port = 123
} },
TargetType = "targetType",
UnhealthyThresholdCount = 123,
VpcId = "vpcId"
};Synopsis
Constructors
| CfnTargetGroupProps() |
Properties
| HealthCheckEnabled | Indicates whether health checks are enabled. |
| HealthCheckIntervalSeconds | The approximate amount of time, in seconds, between health checks of an individual target. |
| HealthCheckPath | [HTTP/HTTPS health checks] The destination for health checks on the targets. |
| HealthCheckPort | The port the load balancer uses when performing health checks on targets. |
| HealthCheckProtocol | The protocol the load balancer uses when performing health checks on targets. |
| HealthCheckTimeoutSeconds | The amount of time, in seconds, during which no response from a target means a failed health check. |
| HealthyThresholdCount | The number of consecutive health check successes required before considering a target healthy. |
| IpAddressType | The type of IP address used for this target group. |
| Matcher | [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. |
| Name | The name of the target group. |
| Port | The port on which the targets receive traffic. |
| Protocol | The protocol to use for routing traffic to the targets. |
| ProtocolVersion | [HTTP/HTTPS protocol] The protocol version. |
| Tags | The tags. |
| TargetGroupAttributes | The attributes. |
| Targets | The targets. |
| TargetType | The type of target that you must specify when registering targets with this target group. |
| UnhealthyThresholdCount | The number of consecutive health check failures required before considering a target unhealthy. |
| VpcId | The identifier of the virtual private cloud (VPC). |
Constructors
CfnTargetGroupProps()
public CfnTargetGroupProps()Properties
HealthCheckEnabled
Indicates whether health checks are enabled.
public object HealthCheckEnabled { get; set; }Property Value
System.Object
Remarks
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.
HealthCheckIntervalSeconds
The approximate amount of time, in seconds, between health checks of an individual target.
public Nullable<double> HealthCheckIntervalSeconds { get; set; }Property Value
System.Nullable<System.Double>
Remarks
The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda , the default is 35 seconds.
HealthCheckPath
[HTTP/HTTPS health checks] The destination for health checks on the targets.
public string HealthCheckPath { get; set; }Property Value
System.String
Remarks
[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.
HealthCheckPort
The port the load balancer uses when performing health checks on targets.
public string HealthCheckPort { get; set; }Property Value
System.String
Remarks
If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port , which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.
HealthCheckProtocol
The protocol the load balancer uses when performing health checks on targets.
public string HealthCheckProtocol { get; set; }Property Value
System.String
Remarks
For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
HealthCheckTimeoutSeconds
The amount of time, in seconds, during which no response from a target means a failed health check.
public Nullable<double> HealthCheckTimeoutSeconds { get; set; }Property Value
System.Nullable<System.Double>
Remarks
The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda , the default is 30 seconds.
HealthyThresholdCount
The number of consecutive health check successes required before considering a target healthy.
public Nullable<double> HealthyThresholdCount { get; set; }Property Value
System.Nullable<System.Double>
Remarks
The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is lambda , the default is 5.
IpAddressType
The type of IP address used for this target group.
public string IpAddressType { get; set; }Property Value
System.String
Remarks
The possible values are ipv4 and ipv6 . This is an optional parameter. If not specified, the IP address type defaults to ipv4 .
Matcher
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
public object Matcher { get; set; }Property Value
System.Object
Remarks
For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
Name
The name of the target group.
public string Name { 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.
Port
The port on which the targets receive traffic.
public Nullable<double> Port { get; set; }Property Value
System.Nullable<System.Double>
Remarks
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.
Protocol
The protocol to use for routing traffic to the targets.
public string Protocol { get; set; }Property Value
System.String
Remarks
For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.
ProtocolVersion
[HTTP/HTTPS protocol] The protocol version.
public string ProtocolVersion { get; set; }Property Value
System.String
Remarks
The possible values are GRPC , HTTP1 , and HTTP2 .
Tags
TargetGroupAttributes
The attributes.
public object TargetGroupAttributes { get; set; }Property Value
System.Object
Remarks
Targets
The targets.
public object Targets { get; set; }Property Value
System.Object
Remarks
TargetType
The type of target that you must specify when registering targets with this target group.
public string TargetType { get; set; }Property Value
System.String
Remarks
You can't specify targets for a target group using more than one target type.
UnhealthyThresholdCount
The number of consecutive health check failures required before considering a target unhealthy.
public Nullable<double> UnhealthyThresholdCount { get; set; }Property Value
System.Nullable<System.Double>
Remarks
The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is lambda , the default is 5.
VpcId
The identifier of the virtual private cloud (VPC).
public string VpcId { get; set; }Property Value
System.String
Remarks
If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.