Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnTargetGroupProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroupProps.Jsii$Proxy
All Implemented Interfaces:
CfnTargetGroupProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnTargetGroupProps
@Stability(Stable) @Internal public static final class CfnTargetGroupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnTargetGroupProps
An implementation for CfnTargetGroupProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnTargetGroupProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnTargetGroupProps.Builder.

  • Method Details

    • getHealthCheckEnabled

      public final Object getHealthCheckEnabled()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getHealthCheckEnabled in interface CfnTargetGroupProps

    • getHealthCheckIntervalSeconds

      public final Number getHealthCheckIntervalSeconds()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getHealthCheckIntervalSeconds in interface CfnTargetGroupProps

    • getHealthCheckPath

      public final String getHealthCheckPath()
      Description copied from interface: CfnTargetGroupProps
      [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.

      Specified by:
      getHealthCheckPath in interface CfnTargetGroupProps

    • getHealthCheckPort

      public final String getHealthCheckPort()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getHealthCheckPort in interface CfnTargetGroupProps

    • getHealthCheckProtocol

      public final String getHealthCheckProtocol()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getHealthCheckProtocol in interface CfnTargetGroupProps

    • getHealthCheckTimeoutSeconds

      public final Number getHealthCheckTimeoutSeconds()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getHealthCheckTimeoutSeconds in interface CfnTargetGroupProps

    • getHealthyThresholdCount

      public final Number getHealthyThresholdCount()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getHealthyThresholdCount in interface CfnTargetGroupProps

    • getIpAddressType

      public final String getIpAddressType()
      Description copied from interface: CfnTargetGroupProps
      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 .

      Specified by:
      getIpAddressType in interface CfnTargetGroupProps

    • getMatcher

      public final Object getMatcher()
      Description copied from interface: CfnTargetGroupProps
      [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.

      Specified by:
      getMatcher in interface CfnTargetGroupProps

    • getName

      public final String getName()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getName in interface CfnTargetGroupProps

    • getPort

      public final Number getPort()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getPort in interface CfnTargetGroupProps

    • getProtocol

      public final String getProtocol()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getProtocol in interface CfnTargetGroupProps

    • getProtocolVersion

      public final String getProtocolVersion()
      Description copied from interface: CfnTargetGroupProps
      [HTTP/HTTPS protocol] The protocol version.

      The possible values are GRPC , HTTP1 , and HTTP2 .

      Specified by:
      getProtocolVersion in interface CfnTargetGroupProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnTargetGroupProps
      The tags.
      Specified by:
      getTags in interface CfnTargetGroupProps

    • getTargetGroupAttributes

      public final Object getTargetGroupAttributes()
      Description copied from interface: CfnTargetGroupProps
      The attributes.
      Specified by:
      getTargetGroupAttributes in interface CfnTargetGroupProps

    • getTargets

      public final Object getTargets()
      Description copied from interface: CfnTargetGroupProps
      The targets.
      Specified by:
      getTargets in interface CfnTargetGroupProps

    • getTargetType

      public final String getTargetType()
      Description copied from interface: CfnTargetGroupProps
      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.
      Specified by:
      getTargetType in interface CfnTargetGroupProps

    • getUnhealthyThresholdCount

      public final Number getUnhealthyThresholdCount()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getUnhealthyThresholdCount in interface CfnTargetGroupProps

    • getVpcId

      public final String getVpcId()
      Description copied from interface: CfnTargetGroupProps
      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.

      Specified by:
      getVpcId in interface CfnTargetGroupProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object