Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnTargetGroupProps.Builder

java.lang.Object
software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroupProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTargetGroupProps>
Enclosing interface:
CfnTargetGroupProps
@Stability(Stable) public static final class CfnTargetGroupProps.Builder extends Object implements software.amazon.jsii.Builder<CfnTargetGroupProps>
A builder for CfnTargetGroupProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • healthCheckEnabled

      @Stability(Stable) public CfnTargetGroupProps.Builder healthCheckEnabled(Boolean healthCheckEnabled)
      Sets the value of CfnTargetGroupProps.getHealthCheckEnabled()
      Parameters:
      healthCheckEnabled - 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 can't be disabled.
      Returns:
      this

    • healthCheckEnabled

      @Stability(Stable) public CfnTargetGroupProps.Builder healthCheckEnabled(IResolvable healthCheckEnabled)
      Sets the value of CfnTargetGroupProps.getHealthCheckEnabled()
      Parameters:
      healthCheckEnabled - 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 can't be disabled.
      Returns:
      this

    • healthCheckIntervalSeconds

      @Stability(Stable) public CfnTargetGroupProps.Builder healthCheckIntervalSeconds(Number healthCheckIntervalSeconds)
      Sets the value of CfnTargetGroupProps.getHealthCheckIntervalSeconds()
      Parameters:
      healthCheckIntervalSeconds - 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.
      Returns:
      this

    • healthCheckPath

      @Stability(Stable) public CfnTargetGroupProps.Builder healthCheckPath(String healthCheckPath)
      Sets the value of CfnTargetGroupProps.getHealthCheckPath()
      Parameters:
      healthCheckPath - [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.

      Returns:
      this

    • healthCheckPort

      @Stability(Stable) public CfnTargetGroupProps.Builder healthCheckPort(String healthCheckPort)
      Sets the value of CfnTargetGroupProps.getHealthCheckPort()
      Parameters:
      healthCheckPort - 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.
      Returns:
      this

    • healthCheckProtocol

      @Stability(Stable) public CfnTargetGroupProps.Builder healthCheckProtocol(String healthCheckProtocol)
      Sets the value of CfnTargetGroupProps.getHealthCheckProtocol()
      Parameters:
      healthCheckProtocol - 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.
      Returns:
      this

    • healthCheckTimeoutSeconds

      @Stability(Stable) public CfnTargetGroupProps.Builder healthCheckTimeoutSeconds(Number healthCheckTimeoutSeconds)
      Sets the value of CfnTargetGroupProps.getHealthCheckTimeoutSeconds()
      Parameters:
      healthCheckTimeoutSeconds - 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.
      Returns:
      this

    • healthyThresholdCount

      @Stability(Stable) public CfnTargetGroupProps.Builder healthyThresholdCount(Number healthyThresholdCount)
      Sets the value of CfnTargetGroupProps.getHealthyThresholdCount()
      Parameters:
      healthyThresholdCount - 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.
      Returns:
      this

    • ipAddressType

      @Stability(Stable) public CfnTargetGroupProps.Builder ipAddressType(String ipAddressType)
      Sets the value of CfnTargetGroupProps.getIpAddressType()
      Parameters:
      ipAddressType - The IP address type. The default value is ipv4 .
      Returns:
      this

    • matcher

      @Stability(Stable) public CfnTargetGroupProps.Builder matcher(IResolvable matcher)
      Sets the value of CfnTargetGroupProps.getMatcher()
      Parameters:
      matcher - [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.
      Returns:
      this

    • matcher

      @Stability(Stable) public CfnTargetGroupProps.Builder matcher(CfnTargetGroup.MatcherProperty matcher)
      Sets the value of CfnTargetGroupProps.getMatcher()
      Parameters:
      matcher - [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.
      Returns:
      this

    • name

      @Stability(Stable) public CfnTargetGroupProps.Builder name(String name)
      Sets the value of CfnTargetGroupProps.getName()
      Parameters:
      name - 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.
      Returns:
      this

    • port

      @Stability(Stable) public CfnTargetGroupProps.Builder port(Number port)
      Sets the value of CfnTargetGroupProps.getPort()
      Parameters:
      port - 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.
      Returns:
      this

    • protocol

      @Stability(Stable) public CfnTargetGroupProps.Builder protocol(String protocol)
      Sets the value of CfnTargetGroupProps.getProtocol()
      Parameters:
      protocol - 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.
      Returns:
      this

    • protocolVersion

      @Stability(Stable) public CfnTargetGroupProps.Builder protocolVersion(String protocolVersion)
      Sets the value of CfnTargetGroupProps.getProtocolVersion()
      Parameters:
      protocolVersion - [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC , HTTP1 , and HTTP2 .
      Returns:
      this

    • tags

      @Stability(Stable) public CfnTargetGroupProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnTargetGroupProps.getTags()
      Parameters:
      tags - The tags.
      Returns:
      this

    • targetGroupAttributes

      @Stability(Stable) public CfnTargetGroupProps.Builder targetGroupAttributes(IResolvable targetGroupAttributes)
      Sets the value of CfnTargetGroupProps.getTargetGroupAttributes()
      Parameters:
      targetGroupAttributes - The target group attributes.
      Returns:
      this

    • targetGroupAttributes

      @Stability(Stable) public CfnTargetGroupProps.Builder targetGroupAttributes(List<? extends Object> targetGroupAttributes)
      Sets the value of CfnTargetGroupProps.getTargetGroupAttributes()
      Parameters:
      targetGroupAttributes - The target group attributes.
      Returns:
      this

    • targets

      @Stability(Stable) public CfnTargetGroupProps.Builder targets(IResolvable targets)
      Sets the value of CfnTargetGroupProps.getTargets()
      Parameters:
      targets - The targets.
      Returns:
      this

    • targets

      @Stability(Stable) public CfnTargetGroupProps.Builder targets(List<? extends Object> targets)
      Sets the value of CfnTargetGroupProps.getTargets()
      Parameters:
      targets - The targets.
      Returns:
      this

    • targetType

      @Stability(Stable) public CfnTargetGroupProps.Builder targetType(String targetType)
      Sets the value of CfnTargetGroupProps.getTargetType()
      Parameters:
      targetType - 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.
      Returns:
      this

    • unhealthyThresholdCount

      @Stability(Stable) public CfnTargetGroupProps.Builder unhealthyThresholdCount(Number unhealthyThresholdCount)
      Sets the value of CfnTargetGroupProps.getUnhealthyThresholdCount()
      Parameters:
      unhealthyThresholdCount - 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.
      Returns:
      this

    • vpcId

      @Stability(Stable) public CfnTargetGroupProps.Builder vpcId(String vpcId)
      Sets the value of CfnTargetGroupProps.getVpcId()
      Parameters:
      vpcId - 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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTargetGroupProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTargetGroupProps>
      Returns:
      a new instance of CfnTargetGroupProps
      Throws:
      NullPointerException - if any required attribute was not provided