CfnTargetGroupProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnTargetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.114Z")
 @Stability(value=Stable)
public interface CfnTargetGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnTargetGroup`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 CfnTargetGroupProps cfnTargetGroupProps = CfnTargetGroupProps.builder()
         .healthCheckEnabled(false)
         .healthCheckIntervalSeconds(123)
         .healthCheckPath("healthCheckPath")
         .healthCheckPort("healthCheckPort")
         .healthCheckProtocol("healthCheckProtocol")
         .healthCheckTimeoutSeconds(123)
         .healthyThresholdCount(123)
         .ipAddressType("ipAddressType")
         .matcher(MatcherProperty.builder()
                 .grpcCode("grpcCode")
                 .httpCode("httpCode")
                 .build())
         .name("name")
         .port(123)
         .protocol("protocol")
         .protocolVersion("protocolVersion")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetGroupAttributes(List.of(TargetGroupAttributeProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targets(List.of(TargetDescriptionProperty.builder()
                 .id("id")
                 // the properties below are optional
                 .availabilityZone("availabilityZone")
                 .port(123)
                 .build()))
         .targetType("targetType")
         .unhealthyThresholdCount(123)
         .vpcId("vpcId")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnTargetGroupProps.Builder` A builder for `CfnTargetGroupProps`
`static class`	`CfnTargetGroupProps.Jsii$Proxy` An implementation for `CfnTargetGroupProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnTargetGroupProps.Builder`	`builder()`
`default Object`	`getHealthCheckEnabled()` Indicates whether health checks are enabled.
`default Number`	`getHealthCheckIntervalSeconds()` The approximate amount of time, in seconds, between health checks of an individual target.
`default String`	`getHealthCheckPath()` [HTTP/HTTPS health checks] The destination for health checks on the targets.
`default String`	`getHealthCheckPort()` The port the load balancer uses when performing health checks on targets.
`default String`	`getHealthCheckProtocol()` The protocol the load balancer uses when performing health checks on targets.
`default Number`	`getHealthCheckTimeoutSeconds()` The amount of time, in seconds, during which no response from a target means a failed health check.
`default Number`	`getHealthyThresholdCount()` The number of consecutive health checks successes required before considering an unhealthy target healthy.
`default String`	`getIpAddressType()` The type of IP address used for this target group.
`default Object`	`getMatcher()` [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
`default String`	`getName()` The name of the target group.
`default Number`	`getPort()` The port on which the targets receive traffic.
`default String`	`getProtocol()` The protocol to use for routing traffic to the targets.
`default String`	`getProtocolVersion()` [HTTP/HTTPS protocol] The protocol version.
`default List<CfnTag>`	`getTags()` The tags.
`default Object`	`getTargetGroupAttributes()` The attributes.
`default Object`	`getTargets()` The targets.
`default String`	`getTargetType()` The type of target that you must specify when registering targets with this target group.
`default Number`	`getUnhealthyThresholdCount()` The number of consecutive health check failures required before considering a target unhealthy.
`default String`	`getVpcId()` The identifier of the virtual private cloud (VPC).

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getHealthCheckEnabled
```
@Stability(value=Stable)
 @Nullable
default Object getHealthCheckEnabled()
```
    Indicates whether health checks are enabled.
    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.
  - getHealthCheckIntervalSeconds
```
@Stability(value=Stable)
 @Nullable
default Number getHealthCheckIntervalSeconds()
```
    The approximate amount of time, in seconds, between health checks of an individual target.
    If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds and 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.
  - getHealthCheckPath
```
@Stability(value=Stable)
 @Nullable
default String getHealthCheckPath()
```
    [HTTP/HTTPS health checks] The destination for health checks on the targets.
    [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.
  - getHealthCheckPort
```
@Stability(value=Stable)
 @Nullable
default String getHealthCheckPort()
```
    The port the load balancer uses when performing health checks on targets.
    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.
  - getHealthCheckProtocol
```
@Stability(value=Stable)
 @Nullable
default String getHealthCheckProtocol()
```
    The protocol the load balancer uses when performing health checks on targets.
    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.
  - getHealthCheckTimeoutSeconds
```
@Stability(value=Stable)
 @Nullable
default Number getHealthCheckTimeoutSeconds()
```
    The amount of time, in seconds, during which no response from a target means a failed health check.
    For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda , the default is 30 seconds.
  - getHealthyThresholdCount
```
@Stability(value=Stable)
 @Nullable
default Number getHealthyThresholdCount()
```
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is lambda , the default is 5.
  - getIpAddressType
```
@Stability(value=Stable)
 @Nullable
default String getIpAddressType()
```
    The type of IP address used for this target group.
    The possible values are ipv4 and ipv6 . This is an optional parameter. If not specified, the IP address type defaults to ipv4 .
  - getMatcher
```
@Stability(value=Stable)
 @Nullable
default Object getMatcher()
```
    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
  - getName
```
@Stability(value=Stable)
 @Nullable
default String getName()
```
    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.
  - getPort
```
@Stability(value=Stable)
 @Nullable
default Number getPort()
```
    The port on which the targets receive traffic.
    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.
  - getProtocol
```
@Stability(value=Stable)
 @Nullable
default String getProtocol()
```
    The protocol to use for routing traffic to the targets.
    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.
  - getProtocolVersion
```
@Stability(value=Stable)
 @Nullable
default String getProtocolVersion()
```
    [HTTP/HTTPS protocol] The protocol version.
    The possible values are GRPC , HTTP1 , and HTTP2 .
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    The tags.
  - getTargetGroupAttributes
```
@Stability(value=Stable)
 @Nullable
default Object getTargetGroupAttributes()
```
    The attributes.
  - getTargets
```
@Stability(value=Stable)
 @Nullable
default Object getTargets()
```
    The targets.
  - getTargetType
```
@Stability(value=Stable)
 @Nullable
default String getTargetType()
```
    The type of target that you must specify when registering targets with this target group.
    You can't specify targets for a target group using more than one target type.
    - instance - Register targets by instance ID. This is the default value.
    - ip - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
    - lambda - Register a single Lambda function as a target.
    - alb - Register a single Application Load Balancer as a target.
  - getUnhealthyThresholdCount
```
@Stability(value=Stable)
 @Nullable
default Number getUnhealthyThresholdCount()
```
    The number of consecutive health check failures required before considering a target unhealthy.
    If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is lambda , the default is 2.
  - getVpcId
```
@Stability(value=Stable)
 @Nullable
default String getVpcId()
```
    The identifier of the virtual private cloud (VPC).
    If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.
  - builder
```
@Stability(value=Stable)
static CfnTargetGroupProps.Builder builder()
```
    Returns:
    
    a CfnTargetGroupProps.Builder of CfnTargetGroupProps

Interface CfnTargetGroupProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getHealthCheckEnabled

getHealthCheckIntervalSeconds

getHealthCheckPath

getHealthCheckPort

getHealthCheckProtocol

getHealthCheckTimeoutSeconds

getHealthyThresholdCount

getIpAddressType

getMatcher

getName

getPort

getProtocol

getProtocolVersion

getTags

getTargetGroupAttributes

getTargets

getTargetType

getUnhealthyThresholdCount

getVpcId

builder