Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnTargetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.309Z") @Stability(Stable) public class CfnTargetGroup extends CfnResource implements IInspectable
A CloudFormation AWS::ElasticLoadBalancingV2::TargetGroup.

Specifies a target group for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.

Before you register a Lambda function as a target, you must create a AWS::Lambda::Permission resource that grants the Elastic Load Balancing service principal permission to invoke the Lambda function.

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.*;
 CfnTargetGroup cfnTargetGroup = CfnTargetGroup.Builder.create(this, "MyCfnTargetGroup")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTargetGroup

      protected CfnTargetGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTargetGroup

      protected CfnTargetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTargetGroup

      @Stability(Stable) public CfnTargetGroup(@NotNull Construct scope, @NotNull String id, @Nullable CfnTargetGroupProps props)
      Create a new AWS::ElasticLoadBalancingV2::TargetGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnTargetGroup

      @Stability(Stable) public CfnTargetGroup(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::ElasticLoadBalancingV2::TargetGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrLoadBalancerArns

      @Stability(Stable) @NotNull public List<String> getAttrLoadBalancerArns()
      The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.

    • getAttrTargetGroupArn

      @Stability(Stable) @NotNull public String getAttrTargetGroupArn()
      The Amazon Resource Name (ARN) of the target group.

    • getAttrTargetGroupFullName

      @Stability(Stable) @NotNull public String getAttrTargetGroupFullName()
      The full name of the target group.

      For example, targetgroup/my-target-group/cbf133c568e0d028 .

    • getAttrTargetGroupName

      @Stability(Stable) @NotNull public String getAttrTargetGroupName()
      The name of the target group.

      For example, my-target-group .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags.

    • getHealthCheckEnabled

      @Stability(Stable) @Nullable public 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.

    • setHealthCheckEnabled

      @Stability(Stable) public void setHealthCheckEnabled(@Nullable Boolean value)
      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.

    • setHealthCheckEnabled

      @Stability(Stable) public void setHealthCheckEnabled(@Nullable IResolvable value)
      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(Stable) @Nullable public Number getHealthCheckIntervalSeconds()
      The approximate amount of time, in seconds, between health checks of an individual target.

      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.

    • setHealthCheckIntervalSeconds

      @Stability(Stable) public void setHealthCheckIntervalSeconds(@Nullable Number value)
      The approximate amount of time, in seconds, between health checks of an individual target.

      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.

    • getHealthCheckPath

      @Stability(Stable) @Nullable public 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.

    • setHealthCheckPath

      @Stability(Stable) public void setHealthCheckPath(@Nullable String value)
      [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(Stable) @Nullable public 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.

    • setHealthCheckPort

      @Stability(Stable) public void setHealthCheckPort(@Nullable String value)
      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(Stable) @Nullable public 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.

    • setHealthCheckProtocol

      @Stability(Stable) public void setHealthCheckProtocol(@Nullable String value)
      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(Stable) @Nullable public Number getHealthCheckTimeoutSeconds()
      The amount of time, in seconds, during which no response from a target means a failed health check.

      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.

    • setHealthCheckTimeoutSeconds

      @Stability(Stable) public void setHealthCheckTimeoutSeconds(@Nullable Number value)
      The amount of time, in seconds, during which no response from a target means a failed health check.

      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.

    • getHealthyThresholdCount

      @Stability(Stable) @Nullable public Number getHealthyThresholdCount()
      The number of consecutive health check successes required before considering a target healthy.

      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.

    • setHealthyThresholdCount

      @Stability(Stable) public void setHealthyThresholdCount(@Nullable Number value)
      The number of consecutive health check successes required before considering a target healthy.

      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.

    • getIpAddressType

      @Stability(Stable) @Nullable public 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 .

    • setIpAddressType

      @Stability(Stable) public void setIpAddressType(@Nullable String value)
      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(Stable) @Nullable public Object getMatcher()
      [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

      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.

    • setMatcher

      @Stability(Stable) public void setMatcher(@Nullable IResolvable value)
      [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

      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.

    • setMatcher

      @Stability(Stable) public void setMatcher(@Nullable CfnTargetGroup.MatcherProperty value)
      [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

      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.

    • getName

      @Stability(Stable) @Nullable public 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.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      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(Stable) @Nullable public 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.

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      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(Stable) @Nullable public 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.

    • setProtocol

      @Stability(Stable) public void setProtocol(@Nullable String value)
      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(Stable) @Nullable public String getProtocolVersion()
      [HTTP/HTTPS protocol] The protocol version.

      The possible values are GRPC , HTTP1 , and HTTP2 .

    • setProtocolVersion

      @Stability(Stable) public void setProtocolVersion(@Nullable String value)
      [HTTP/HTTPS protocol] The protocol version.

      The possible values are GRPC , HTTP1 , and HTTP2 .

    • getTargetGroupAttributes

      @Stability(Stable) @Nullable public Object getTargetGroupAttributes()
      The attributes.

    • setTargetGroupAttributes

      @Stability(Stable) public void setTargetGroupAttributes(@Nullable IResolvable value)
      The attributes.

    • setTargetGroupAttributes

      @Stability(Stable) public void setTargetGroupAttributes(@Nullable List<Object> value)
      The attributes.

    • getTargets

      @Stability(Stable) @Nullable public Object getTargets()
      The targets.

    • setTargets

      @Stability(Stable) public void setTargets(@Nullable IResolvable value)
      The targets.

    • setTargets

      @Stability(Stable) public void setTargets(@Nullable List<Object> value)
      The targets.

    • getTargetType

      @Stability(Stable) @Nullable public 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.

    • setTargetType

      @Stability(Stable) public void setTargetType(@Nullable String value)
      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(Stable) @Nullable public Number getUnhealthyThresholdCount()
      The number of consecutive health check failures required before considering a target unhealthy.

      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.

    • setUnhealthyThresholdCount

      @Stability(Stable) public void setUnhealthyThresholdCount(@Nullable Number value)
      The number of consecutive health check failures required before considering a target unhealthy.

      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.

    • getVpcId

      @Stability(Stable) @Nullable public 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.

    • setVpcId

      @Stability(Stable) public void setVpcId(@Nullable String value)
      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.