Package software.amazon.awscdk.services.elasticloadbalancingv2

Class ApplicationTargetGroupProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroupProps.Jsii$Proxy

All Implemented Interfaces:

ApplicationTargetGroupProps, BaseTargetGroupProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ApplicationTargetGroupProps

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

An implementation for ApplicationTargetGroupProps

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.services.elasticloadbalancingv2.ApplicationTargetGroupProps

ApplicationTargetGroupProps.Builder, ApplicationTargetGroupProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(ApplicationTargetGroupProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the ApplicationTargetGroupProps.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 Boolean	getCrossZoneEnabled()	Indicates whether cross zone load balancing is enabled.
final Duration	getDeregistrationDelay()	The amount of time for Elastic Load Balancing to wait before deregistering a target.
final Boolean	getEnableAnomalyMitigation()	Indicates whether anomaly mitigation is enabled.
final HealthCheck	getHealthCheck()	Health check configuration.
final TargetGroupIpAddressType	getIpAddressType()	The type of IP addresses of the targets registered with the target group.
final TargetGroupLoadBalancingAlgorithmType	getLoadBalancingAlgorithmType()	The load balancing algorithm to select targets for routing requests.
final Boolean	getMultiValueHeadersEnabled()	Indicates whether the target group supports multi-value headers.
final Number	getPort()	The port on which the target receives traffic.
final ApplicationProtocol	getProtocol()	The protocol used for communication with the target.
final ApplicationProtocolVersion	getProtocolVersion()	The protocol version to use.
final Duration	getSlowStart()	The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group.
final Duration	getStickinessCookieDuration()	The stickiness cookie expiration period.
final String	getStickinessCookieName()	The name of an application-based stickiness cookie.
final TargetGroupHealth	getTargetGroupHealth()	Configuring target group health.
final String	getTargetGroupName()	The name of the target group.
final List<IApplicationLoadBalancerTarget>	getTargets()	The targets to add to this target group.
final TargetType	getTargetType()	The type of targets registered to this TargetGroup, either IP or Instance.
final IVpc	getVpc()	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(ApplicationTargetGroupProps.Builder builder)

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

Method Details

getEnableAnomalyMitigation

public final Boolean getEnableAnomalyMitigation()

Description copied from interface: ApplicationTargetGroupProps

Indicates whether anomaly mitigation is enabled.

Only available when loadBalancingAlgorithmType is TargetGroupLoadBalancingAlgorithmType.WEIGHTED_RANDOM

Default: false

Specified by:

getEnableAnomalyMitigation in interface ApplicationTargetGroupProps

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#automatic-target-weights

getLoadBalancingAlgorithmType

public final TargetGroupLoadBalancingAlgorithmType getLoadBalancingAlgorithmType()

Description copied from interface: ApplicationTargetGroupProps

The load balancing algorithm to select targets for routing requests.

Default: TargetGroupLoadBalancingAlgorithmType.ROUND_ROBIN

Specified by:

getLoadBalancingAlgorithmType in interface ApplicationTargetGroupProps

getMultiValueHeadersEnabled

public final Boolean getMultiValueHeadersEnabled()

Description copied from interface: ApplicationTargetGroupProps

Indicates whether the target group supports multi-value headers.

If the value is true, the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings.

Only applicable for Lambda targets.

Default: false

Specified by:

getMultiValueHeadersEnabled in interface ApplicationTargetGroupProps

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes

getPort

public final Number getPort()

Description copied from interface: ApplicationTargetGroupProps

The port on which the target receives traffic.

This is not applicable for Lambda targets.

Default: - Determined from protocol if known

Specified by:

getPort in interface ApplicationTargetGroupProps

getProtocol

public final ApplicationProtocol getProtocol()

Description copied from interface: ApplicationTargetGroupProps

The protocol used for communication with the target.

This is not applicable for Lambda targets.

Default: - Determined from port if known

Specified by:

getProtocol in interface ApplicationTargetGroupProps

getProtocolVersion

public final ApplicationProtocolVersion getProtocolVersion()

Description copied from interface: ApplicationTargetGroupProps

The protocol version to use.

Default: ApplicationProtocolVersion.HTTP1

Specified by:

getProtocolVersion in interface ApplicationTargetGroupProps

getSlowStart

public final Duration getSlowStart()

Description copied from interface: ApplicationTargetGroupProps

The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group.

The range is 30-900 seconds (15 minutes).

Default: 0

Specified by:

getSlowStart in interface ApplicationTargetGroupProps

getStickinessCookieDuration

public final Duration getStickinessCookieDuration()

Description copied from interface: ApplicationTargetGroupProps

The stickiness cookie expiration period.

Setting this value enables load balancer stickiness.

After this period, the cookie is considered stale. The minimum value is 1 second and the maximum value is 7 days (604800 seconds).

Default: - Stickiness is disabled

Specified by:

getStickinessCookieDuration in interface ApplicationTargetGroupProps

getStickinessCookieName

public final String getStickinessCookieName()

Description copied from interface: ApplicationTargetGroupProps

The name of an application-based stickiness cookie.

Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.

Note: stickinessCookieName parameter depends on the presence of stickinessCookieDuration parameter. If stickinessCookieDuration is not set, stickinessCookieName will be omitted.

Default: - If `stickinessCookieDuration` is set, a load-balancer generated cookie is used. Otherwise, no stickiness is defined.

Specified by:

getStickinessCookieName in interface ApplicationTargetGroupProps

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html

getTargets

public final List<IApplicationLoadBalancerTarget> getTargets()

Description copied from interface: ApplicationTargetGroupProps

The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing target. If you use either Instance or IPAddress as targets, all target must be of the same type.

Default: - No targets.

Specified by:

getTargets in interface ApplicationTargetGroupProps

getCrossZoneEnabled

public final Boolean getCrossZoneEnabled()

Description copied from interface: BaseTargetGroupProps

Indicates whether cross zone load balancing is enabled.

Default: - use load balancer configuration

Specified by:

getCrossZoneEnabled in interface BaseTargetGroupProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html

getDeregistrationDelay

public final Duration getDeregistrationDelay()

Description copied from interface: BaseTargetGroupProps

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0-3600 seconds.

Default: 300

Specified by:

getDeregistrationDelay in interface BaseTargetGroupProps

getHealthCheck

public final HealthCheck getHealthCheck()

Description copied from interface: BaseTargetGroupProps

Health check configuration.

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

Specified by:

getHealthCheck in interface BaseTargetGroupProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties

getIpAddressType

public final TargetGroupIpAddressType getIpAddressType()

Description copied from interface: BaseTargetGroupProps

The type of IP addresses of the targets registered with the target group.

Default: undefined - ELB defaults to IPv4

Specified by:

getIpAddressType in interface BaseTargetGroupProps

getTargetGroupHealth

public final TargetGroupHealth getTargetGroupHealth()

Description copied from interface: BaseTargetGroupProps

Configuring target group health.

Default: - use default configuration

Specified by:

getTargetGroupHealth in interface BaseTargetGroupProps

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes

getTargetGroupName

public final String getTargetGroupName()

Description copied from interface: BaseTargetGroupProps

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.

Specified by:

getTargetGroupName in interface BaseTargetGroupProps

getTargetType

public final TargetType getTargetType()

Description copied from interface: BaseTargetGroupProps

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.

Specified by:

getTargetType in interface BaseTargetGroupProps

getVpc

public final IVpc getVpc()

Description copied from interface: BaseTargetGroupProps

The virtual private cloud (VPC).

only if TargetType is Ip or InstanceId

Default: - undefined

Specified by:

getVpc in interface BaseTargetGroupProps

$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