Package software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2

Class CfnTargetGroupMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2.CfnTargetGroupMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnTargetGroupMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnTargetGroupMixinProps

@Stability(Stable)
@Internal
public static final class CfnTargetGroupMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnTargetGroupMixinProps

An implementation for CfnTargetGroupMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2.CfnTargetGroupMixinProps

CfnTargetGroupMixinProps.Builder, CfnTargetGroupMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnTargetGroupMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnTargetGroupMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getHealthCheckEnabled()	Indicates whether health checks are enabled.
final Number	getHealthCheckIntervalSeconds()	The approximate amount of time, in seconds, between health checks of an individual target.
final String	getHealthCheckPath()	[HTTP/HTTPS health checks] The destination for health checks on the targets.
final String	getHealthCheckPort()	The port the load balancer uses when performing health checks on targets.
final String	getHealthCheckProtocol()	The protocol the load balancer uses when performing health checks on targets.
final Number	getHealthCheckTimeoutSeconds()	The amount of time, in seconds, during which no response from a target means a failed health check.
final Number	getHealthyThresholdCount()	The number of consecutive health check successes required before considering a target healthy.
final String	getIpAddressType()	The IP address type.
final Object	getMatcher()	[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
final String	getName()	The name of the target group.
final Number	getPort()	The port on which the targets receive traffic.
final String	getProtocol()	The protocol to use for routing traffic to the targets.
final String	getProtocolVersion()	[HTTP/HTTPS protocol] The protocol version.
final List<CfnTag>	getTags()	The tags.
final Number	getTargetControlPort()	The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.
final Object	getTargetGroupAttributes()	The target group attributes.
final Object	getTargets()	The targets.
final String	getTargetType()	The type of target that you must specify when registering targets with this target group.
final Number	getUnhealthyThresholdCount()	The number of consecutive health check failures required before considering a target unhealthy.
final Object	getVpcId()	The identifier of the virtual private cloud (VPC).
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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(CfnTargetGroupMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnTargetGroupMixinProps.Builder.

Method Details

getHealthCheckEnabled

public final Object getHealthCheckEnabled()

Description copied from interface: CfnTargetGroupMixinProps

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 union: either Boolean or IResolvable

Specified by:

getHealthCheckEnabled in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled

getHealthCheckIntervalSeconds

public final Number getHealthCheckIntervalSeconds()

Description copied from interface: CfnTargetGroupMixinProps

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, QUIC, TCP_QUIC, 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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds

getHealthCheckPath

public final String getHealthCheckPath()

Description copied from interface: CfnTargetGroupMixinProps

[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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath

getHealthCheckPort

public final String getHealthCheckPort()

Description copied from interface: CfnTargetGroupMixinProps

The port the load balancer uses when performing health checks on targets.

If the protocol is HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC 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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport

getHealthCheckProtocol

public final String getHealthCheckProtocol()

Description copied from interface: CfnTargetGroupMixinProps

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, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.

Specified by:

getHealthCheckProtocol in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol

getHealthCheckTimeoutSeconds

public final Number getHealthCheckTimeoutSeconds()

Description copied from interface: CfnTargetGroupMixinProps

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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds

getHealthyThresholdCount

public final Number getHealthyThresholdCount()

Description copied from interface: CfnTargetGroupMixinProps

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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount

getIpAddressType

public final String getIpAddressType()

Description copied from interface: CfnTargetGroupMixinProps

The IP address type.

The default value is ipv4 .

Specified by:

getIpAddressType in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-ipaddresstype

getMatcher

public final Object getMatcher()

Description copied from interface: CfnTargetGroupMixinProps

[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, QUIC, TCP_QUIC, 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 union: either IResolvable or CfnTargetGroupPropsMixin.MatcherProperty

Specified by:

getMatcher in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher

getName

public final String getName()

Description copied from interface: CfnTargetGroupMixinProps

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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name

getPort

public final Number getPort()

Description copied from interface: CfnTargetGroupMixinProps

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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port

getProtocol

public final String getProtocol()

Description copied from interface: CfnTargetGroupMixinProps

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, TCP_UDP, QUIC, or TCP_QUIC. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. A TCP_QUIC listener must be associated with a TCP_QUIC target group. If the target is a Lambda function, this parameter does not apply.

Specified by:

getProtocol in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol

getProtocolVersion

public final String getProtocolVersion()

Description copied from interface: CfnTargetGroupMixinProps

[HTTP/HTTPS protocol] The protocol version.

The possible values are GRPC , HTTP1 , and HTTP2 .

Specified by:

getProtocolVersion in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocolversion

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnTargetGroupMixinProps

The tags.

Specified by:

getTags in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags

getTargetControlPort

public final Number getTargetControlPort()

Description copied from interface: CfnTargetGroupMixinProps

The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.

Specified by:

getTargetControlPort in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetcontrolport

getTargetGroupAttributes

public final Object getTargetGroupAttributes()

Description copied from interface: CfnTargetGroupMixinProps

The target group attributes.

Attributes that you do not modify retain their current values.

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

Specified by:

getTargetGroupAttributes in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes

getTargets

public final Object getTargets()

Description copied from interface: CfnTargetGroupMixinProps

The targets.

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

Specified by:

getTargets in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets

getTargetType

public final String getTargetType()

Description copied from interface: CfnTargetGroupMixinProps

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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype

getUnhealthyThresholdCount

public final Number getUnhealthyThresholdCount()

Description copied from interface: CfnTargetGroupMixinProps

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, QUIC, TCP_QUIC, 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 CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount

getVpcId

public final Object getVpcId()

Description copied from interface: CfnTargetGroupMixinProps

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 union: either String or IVPCRef

Specified by:

getVpcId in interface CfnTargetGroupMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid

$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