Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnTargetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroup
All Implemented Interfaces:
IInspectable, ITaggable, ITargetGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:39.868Z") @Stability(Stable) public class CfnTargetGroup extends CfnResource implements IInspectable, ITargetGroupRef, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnTargetGroupProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnTargetGroup

      @Stability(Stable) public CfnTargetGroup(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getTargetGroupRef

      @Stability(Stable) @NotNull public TargetGroupReference getTargetGroupRef()
      A reference to a TargetGroup resource.
      Specified by:
      getTargetGroupRef in interface ITargetGroupRef

    • getHealthCheckEnabled

      @Stability(Stable) @Nullable public Object getHealthCheckEnabled()
      Indicates whether health checks are enabled.

      Returns union: either Boolean or IResolvable

    • setHealthCheckEnabled

      @Stability(Stable) public void setHealthCheckEnabled(@Nullable Boolean value)
      Indicates whether health checks are enabled.

    • setHealthCheckEnabled

      @Stability(Stable) public void setHealthCheckEnabled(@Nullable IResolvable value)
      Indicates whether health checks are enabled.

    • getHealthCheckIntervalSeconds

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

    • setHealthCheckIntervalSeconds

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

    • getHealthCheckPath

      @Stability(Stable) @Nullable public String getHealthCheckPath()
      [HTTP/HTTPS health checks] The destination for health checks on the targets.

    • setHealthCheckPath

      @Stability(Stable) public void setHealthCheckPath(@Nullable String value)
      [HTTP/HTTPS health checks] The destination for health checks on the targets.

    • getHealthCheckPort

      @Stability(Stable) @Nullable public String getHealthCheckPort()
      The port the load balancer uses when performing health checks on targets.

    • setHealthCheckPort

      @Stability(Stable) public void setHealthCheckPort(@Nullable String value)
      The port the load balancer uses when performing health checks on targets.

    • getHealthCheckProtocol

      @Stability(Stable) @Nullable public String getHealthCheckProtocol()
      The protocol the load balancer uses when performing health checks on targets.

    • setHealthCheckProtocol

      @Stability(Stable) public void setHealthCheckProtocol(@Nullable String value)
      The protocol the load balancer uses when performing health checks on targets.

    • 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.

    • 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.

    • getHealthyThresholdCount

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

    • setHealthyThresholdCount

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

    • getIpAddressType

      @Stability(Stable) @Nullable public String getIpAddressType()
      The IP address type.

    • setIpAddressType

      @Stability(Stable) public void setIpAddressType(@Nullable String value)
      The IP address type.

    • 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.

      Returns union: either IResolvable or CfnTargetGroup.MatcherProperty

    • 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.

    • 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.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the target group.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the target group.

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The port on which the targets receive traffic.

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The port on which the targets receive traffic.

    • getProtocol

      @Stability(Stable) @Nullable public String getProtocol()
      The protocol to use for routing traffic to the targets.

    • setProtocol

      @Stability(Stable) public void setProtocol(@Nullable String value)
      The protocol to use for routing traffic to the targets.

    • getProtocolVersion

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

    • setProtocolVersion

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags.

    • getTargetGroupAttributes

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

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTargetGroup.TargetGroupAttributeProperty>

    • setTargetGroupAttributes

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

    • setTargetGroupAttributes

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

    • getTargets

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

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTargetGroup.TargetDescriptionProperty>

    • 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.

    • setTargetType

      @Stability(Stable) public void setTargetType(@Nullable String value)
      The type of target that you must specify when registering targets with this target group.

    • getUnhealthyThresholdCount

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

    • setUnhealthyThresholdCount

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

    • getVpcId

      @Stability(Stable) @Nullable public String getVpcId()
      The identifier of the virtual private cloud (VPC).

    • setVpcId

      @Stability(Stable) public void setVpcId(@Nullable String value)
      The identifier of the virtual private cloud (VPC).