BaseTargetGroupProps

class aws_cdk.aws_elasticloadbalancingv2.BaseTargetGroupProps(*, deregistration_delay=None, health_check=None, target_group_name=None, target_type=None, vpc=None)

Bases: object

Basic properties of both Application and Network Target Groups.

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: 300

  • health_check (Union[HealthCheck, Dict[str, Any], None]) – Health check configuration. Default: - The default value for each property in this configuration varies depending on the target.

  • 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 if TargetType is Ip or InstanceId Default: - undefined

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_elasticloadbalancingv2 as elbv2
import aws_cdk.core as cdk

# vpc: ec2.Vpc

base_target_group_props = elbv2.BaseTargetGroupProps(
    deregistration_delay=cdk.Duration.minutes(30),
    health_check=elbv2.HealthCheck(
        enabled=False,
        healthy_grpc_codes="healthyGrpcCodes",
        healthy_http_codes="healthyHttpCodes",
        healthy_threshold_count=123,
        interval=cdk.Duration.minutes(30),
        path="path",
        port="port",
        protocol=elbv2.Protocol.HTTP,
        timeout=cdk.Duration.minutes(30),
        unhealthy_threshold_count=123
    ),
    target_group_name="targetGroupName",
    target_type=elbv2.TargetType.INSTANCE,
    vpc=vpc
)

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

health_check

Health check configuration.

Default:

  • The default value for each property in this configuration varies depending on the target.

See:

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

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.

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.

vpc

The virtual private cloud (VPC).

only if TargetType is Ip or InstanceId

Default:

  • undefined