software.amazon.awscdk.services.elasticloadbalancingv2

Interface AddApplicationTargetsProps

All Superinterfaces:

AddRuleProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddApplicationTargetsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:18.636Z")
 @Stability(value=Experimental)
public interface AddApplicationTargetsProps
extends software.amazon.jsii.JsiiSerializable, AddRuleProps

(experimental) Properties for adding new targets to a listener.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AddApplicationTargetsProps.Builder A builder for AddApplicationTargetsProps
static class	AddApplicationTargetsProps.Jsii$Proxy An implementation for AddApplicationTargetsProps

Method Summary

Modifier and Type	Method and Description
static AddApplicationTargetsProps.Builder	builder()
default Duration	getDeregistrationDelay() (experimental) The amount of time for Elastic Load Balancing to wait before deregistering a target.
default HealthCheck	getHealthCheck() (experimental) Health check configuration.
default Number	getPort() (experimental) The port on which the listener listens for requests.
default ApplicationProtocol	getProtocol() (experimental) The protocol to use.
default ApplicationProtocolVersion	getProtocolVersion() (experimental) The protocol version to use.
default Duration	getSlowStart() (experimental) The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group.
default Duration	getStickinessCookieDuration() (experimental) The stickiness cookie expiration period.
default String	getStickinessCookieName() (experimental) The name of an application-based stickiness cookie.
default String	getTargetGroupName() (experimental) The name of the target group.
default List<IApplicationLoadBalancerTarget>	getTargets() (experimental) The targets to add to this target group.

Methods inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.AddRuleProps

getConditions, getPriority

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeregistrationDelay

@Stability(value=Experimental)
 @Nullable
default Duration getDeregistrationDelay()

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

The range is 0-3600 seconds.

Default: Duration.minutes(5)

getHealthCheck

@Stability(value=Experimental)
 @Nullable
default HealthCheck getHealthCheck()

(experimental) Health check configuration.

Default: No health check

getPort

@Stability(value=Experimental)
 @Nullable
default Number getPort()

(experimental) The port on which the listener listens for requests.

Default: Determined from protocol if known

getProtocol

@Stability(value=Experimental)
 @Nullable
default ApplicationProtocol getProtocol()

(experimental) The protocol to use.

Default: Determined from port if known

getProtocolVersion

@Stability(value=Experimental)
 @Nullable
default ApplicationProtocolVersion getProtocolVersion()

(experimental) The protocol version to use.

Default: ApplicationProtocolVersion.HTTP1

getSlowStart

@Stability(value=Experimental)
 @Nullable
default Duration getSlowStart()

(experimental) 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

getStickinessCookieDuration

@Stability(value=Experimental)
 @Nullable
default Duration getStickinessCookieDuration()

(experimental) 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 disabled

getStickinessCookieName

@Stability(value=Experimental)
 @Nullable
default String getStickinessCookieName()

(experimental) 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.

See Also:

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

getTargetGroupName

@Stability(value=Experimental)
 @Nullable
default String getTargetGroupName()

(experimental) 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

getTargets

@Stability(value=Experimental)
 @Nullable
default List<IApplicationLoadBalancerTarget> getTargets()

(experimental) The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing target. All target must be of the same type.

builder

@Stability(value=Experimental)
static AddApplicationTargetsProps.Builder builder()

Specified by:

builder in interface AddRuleProps

Returns:

a AddApplicationTargetsProps.Builder of AddApplicationTargetsProps