Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface BaseTargetGroupProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ApplicationTargetGroupProps, NetworkTargetGroupProps
All Known Implementing Classes:
ApplicationTargetGroupProps.Jsii$Proxy, BaseTargetGroupProps.Jsii$Proxy, NetworkTargetGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.226Z") @Stability(Stable) public interface BaseTargetGroupProps extends software.amazon.jsii.JsiiSerializable
Basic properties of both Application and Network Target Groups.

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.ec2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 import software.amazon.awscdk.core.*;
 Vpc vpc;
 BaseTargetGroupProps baseTargetGroupProps = BaseTargetGroupProps.builder()
         .deregistrationDelay(Duration.minutes(30))
         .healthCheck(HealthCheck.builder()
                 .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)
                 .build())
         .targetGroupName("targetGroupName")
         .targetType(TargetType.INSTANCE)
         .vpc(vpc)
         .build();

  • Method Details

    • getDeregistrationDelay

      @Stability(Stable) @Nullable default Duration getDeregistrationDelay()
      The amount of time for Elastic Load Balancing to wait before deregistering a target.

      The range is 0-3600 seconds.

      Default: 300

    • getHealthCheck

      @Stability(Stable) @Nullable default HealthCheck getHealthCheck()
      Health check configuration.

      Default: - The default value for each property in this configuration varies depending on the target.

      See Also:

    • getTargetGroupName

      @Stability(Stable) @Nullable default String getTargetGroupName()
      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.

      Default: - Automatically generated.

    • getTargetType

      @Stability(Stable) @Nullable default TargetType getTargetType()
      The type of targets registered to this TargetGroup, either IP or Instance.

      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.

    • getVpc

      @Stability(Stable) @Nullable default IVpc getVpc()
      The virtual private cloud (VPC).

      only if TargetType is Ip or InstanceId

      Default: - undefined

    • builder

      @Stability(Stable) static BaseTargetGroupProps.Builder builder()
      Returns:
      a BaseTargetGroupProps.Builder of BaseTargetGroupProps