ApplicationTargetGroupProps¶
-
class
aws_cdk.aws_elasticloadbalancingv2.
ApplicationTargetGroupProps
(*, deregistration_delay=None, health_check=None, target_group_name=None, target_type=None, vpc=None, port=None, protocol=None, slow_start=None, stickiness_cookie_duration=None, targets=None)¶ Bases:
aws_cdk.aws_elasticloadbalancingv2.BaseTargetGroupProps
Properties for defining an Application Target Group.
- Parameters
deregistration_delay (
Optional
[Duration
]) – The amount of time for Elastic Load Balancing to wait before deregistering a target. The range is 0-3600 seconds. Default: 300health_check (
Optional
[HealthCheck
]) – Health check configuration. Default: - None.target_group_name (
Optional
[str
]) – 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.target_type (
Optional
[TargetType
]) – 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.vpc (
Optional
[IVpc
]) – The virtual private cloud (VPC). only ifTargetType
isIp
orInstanceId
Default: - undefinedport (
Union
[int
,float
,None
]) – The port on which the listener listens for requests. Default: - Determined from protocol if known, optional for Lambda targets.protocol (
Optional
[ApplicationProtocol
]) – The protocol to use. Default: - Determined from port if known, optional for Lambda targets.slow_start (
Optional
[Duration
]) – 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: 0stickiness_cookie_duration (
Optional
[Duration
]) – 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: Duration.days(1)targets (
Optional
[List
[IApplicationLoadBalancerTarget
]]) – The targets to add to this target group. Can beInstance
,IPAddress
, or any self-registering load balancing target. If you use eitherInstance
orIPAddress
as targets, all target must be of the same type. Default: - No targets.
Attributes
-
deregistration_delay
¶ The amount of time for Elastic Load Balancing to wait before deregistering a target.
The range is 0-3600 seconds.
- Default
300
- Return type
Optional
[Duration
]
-
health_check
¶ Health check configuration.
- Default
None.
- Return type
Optional
[HealthCheck
]
-
port
¶ The port on which the listener listens for requests.
- Default
Determined from protocol if known, optional for Lambda targets.
- Return type
Union
[int
,float
,None
]
-
protocol
¶ The protocol to use.
- Default
Determined from port if known, optional for Lambda targets.
- Return type
Optional
[ApplicationProtocol
]
-
slow_start
¶ 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
- Return type
Optional
[Duration
]
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
Duration.days(1)
- Return type
Optional
[Duration
]
-
target_group_name
¶ 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.
- Return type
Optional
[str
]
-
target_type
¶ 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.
- Return type
Optional
[TargetType
]
-
targets
¶ The targets to add to this target group.
Can be
Instance
,IPAddress
, or any self-registering load balancing target. If you use eitherInstance
orIPAddress
as targets, all target must be of the same type.- Default
No targets.
- Return type
Optional
[List
[IApplicationLoadBalancerTarget
]]