@guardian/cdk
    Preparing search index...

    Interface GuApplicationTargetGroupProps

    interface GuApplicationTargetGroupProps {
        app: string;
        crossZoneEnabled?: boolean;
        deregistrationDelay?: Duration;
        enableAnomalyMitigation?: boolean;
        healthCheck?: HealthCheck;
        ipAddressType?: TargetGroupIpAddressType;
        loadBalancingAlgorithmType?: TargetGroupLoadBalancingAlgorithmType;
        multiValueHeadersEnabled?: boolean;
        port?: number;
        protocol?: ApplicationProtocol;
        protocolVersion?: ApplicationProtocolVersion;
        slowStart?: Duration;
        stickinessCookieDuration?: Duration;
        stickinessCookieName?: string;
        targetGroupName?: string;
        targets?: IApplicationLoadBalancerTarget[];
        targetType?: TargetType;
        vpc?: IVpc;
    }

    Hierarchy (View Summary)

    • ApplicationTargetGroupProps
    • AppIdentity
      • GuApplicationTargetGroupProps
    Index

    Properties

    app crossZoneEnabled? deregistrationDelay? enableAnomalyMitigation? healthCheck? ipAddressType? loadBalancingAlgorithmType? multiValueHeadersEnabled? port? protocol? protocolVersion? slowStart? stickinessCookieDuration? stickinessCookieName? targetGroupName? targets? targetType? vpc?

    Properties

    app: string
    crossZoneEnabled?: boolean

    Indicates whether cross zone load balancing is enabled.

    - use load balancer configuration

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

    deregistrationDelay?: Duration

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

    The range is 0-3600 seconds.

    300
    enableAnomalyMitigation?: boolean

    Indicates whether anomaly mitigation is enabled.

    Only available when loadBalancingAlgorithmType is TargetGroupLoadBalancingAlgorithmType.WEIGHTED_RANDOM

    false

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

    healthCheck?: HealthCheck

    Health check configuration

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

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

    ipAddressType?: TargetGroupIpAddressType

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

    undefined - ELB defaults to IPv4
    loadBalancingAlgorithmType?: TargetGroupLoadBalancingAlgorithmType

    The load balancing algorithm to select targets for routing requests.

    TargetGroupLoadBalancingAlgorithmType.ROUND_ROBIN
    multiValueHeadersEnabled?: boolean

    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.

    false

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

    port?: number

    The port on which the target receives traffic.

    This is not applicable for Lambda targets.

    - Determined from protocol if known
    protocol?: ApplicationProtocol

    The protocol used for communication with the target.

    This is not applicable for Lambda targets.

    - Determined from port if known
    protocolVersion?: ApplicationProtocolVersion

    The protocol version to use

    ApplicationProtocolVersion.HTTP1
    slowStart?: 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).

    0
    stickinessCookieDuration?: 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).

    - Stickiness is disabled
    stickinessCookieName?: string

    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.

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

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

    targetGroupName?: string

    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.

    - Automatically generated.
    targets?: IApplicationLoadBalancerTarget[]

    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.

    - No targets.
    targetType?: 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.

    - Determined automatically.
    vpc?: IVpc

    The virtual private cloud (VPC).

    only if TargetType is Ip or InstanceId

    - undefined

    Settings

    Member Visibility

    On This Page

    Properties