AddApplicationTargetsProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: AddRuleProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: AddApplicationTargetsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.050Z")
 @Stability(value=Stable)
public interface AddApplicationTargetsProps
extends software.amazon.jsii.JsiiSerializable, AddRuleProps

Properties for adding new targets to a listener.

Example:

 import software.amazon.awscdk.services.autoscaling.AutoScalingGroup;
 AutoScalingGroup asg;
 Vpc vpc;
 // Create the load balancer in a VPC. 'internetFacing' is 'false'
 // by default, which creates an internal load balancer.
 ApplicationLoadBalancer lb = ApplicationLoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .build();
 // Add a listener and open up the load balancer's security group
 // to the world.
 ApplicationListener listener = lb.addListener("Listener", BaseApplicationListenerProps.builder()
         .port(80)
         // 'open: true' is the default, you can leave it out if you want. Set it
         // to 'false' and use `listener.connections` if you want to be selective
         // about who can access the load balancer.
         .open(true)
         .build());
 // Create an AutoScaling group and add it as a load balancing
 // target to the listener.
 listener.addTargets("ApplicationFleet", AddApplicationTargetsProps.builder()
         .port(8080)
         .targets(List.of(asg))
         .build());

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

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static AddApplicationTargetsProps.Builder`	`builder()`
`default Duration`	`getDeregistrationDelay()` The amount of time for Elastic Load Balancing to wait before deregistering a target.
`default HealthCheck`	`getHealthCheck()` Health check configuration.
`default TargetGroupLoadBalancingAlgorithmType`	`getLoadBalancingAlgorithmType()` The load balancing algorithm to select targets for routing requests.
`default Number`	`getPort()` The port on which the listener listens for requests.
`default ApplicationProtocol`	`getProtocol()` The protocol to use.
`default ApplicationProtocolVersion`	`getProtocolVersion()` The protocol version to use.
`default 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.
`default Duration`	`getStickinessCookieDuration()` The stickiness cookie expiration period.
`default String`	`getStickinessCookieName()` The name of an application-based stickiness cookie.
`default String`	`getTargetGroupName()` The name of the target group.
`default List<IApplicationLoadBalancerTarget>`	`getTargets()` 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=Stable)
 @Nullable
default Duration getDeregistrationDelay()
```
    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=Stable)
 @Nullable
default HealthCheck getHealthCheck()
```
    Health check configuration.
    Default: - The default value for each property in this configuration varies depending on the target.
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties
  - getLoadBalancingAlgorithmType
```
@Stability(value=Stable)
 @Nullable
default TargetGroupLoadBalancingAlgorithmType getLoadBalancingAlgorithmType()
```
    The load balancing algorithm to select targets for routing requests.
    Default: round_robin.
  - getPort
```
@Stability(value=Stable)
 @Nullable
default Number getPort()
```
    The port on which the listener listens for requests.
    Default: Determined from protocol if known
  - getProtocol
```
@Stability(value=Stable)
 @Nullable
default ApplicationProtocol getProtocol()
```
    The protocol to use.
    Default: Determined from port if known
  - getProtocolVersion
```
@Stability(value=Stable)
 @Nullable
default ApplicationProtocolVersion getProtocolVersion()
```
    The protocol version to use.
    Default: ApplicationProtocolVersion.HTTP1
  - getSlowStart
```
@Stability(value=Stable)
 @Nullable
default 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.
    The range is 30-900 seconds (15 minutes).
    Default: 0
  - getStickinessCookieDuration
```
@Stability(value=Stable)
 @Nullable
default Duration getStickinessCookieDuration()
```
    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=Stable)
 @Nullable
default String getStickinessCookieName()
```
    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=Stable)
 @Nullable
default String getTargetGroupName()
```
    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=Stable)
 @Nullable
default List<IApplicationLoadBalancerTarget> getTargets()
```
    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=Stable)
static AddApplicationTargetsProps.Builder builder()
```
    Specified by:
    
    builder in interface AddRuleProps
    
    Returns:
    
    a AddApplicationTargetsProps.Builder of AddApplicationTargetsProps

Interface AddApplicationTargetsProps

Nested Class Summary

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getDeregistrationDelay

getHealthCheck

getLoadBalancingAlgorithmType

getPort

getProtocol

getProtocolVersion

getSlowStart

getStickinessCookieDuration

getStickinessCookieName

getTargetGroupName

getTargets

builder