Skip to content

TrafficSourceState

Source code in docs_src/capo_auto_scaling/types/traffic_source_state.py
class TrafficSourceState(TypedDict, closed=True):
    traffic_source: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len511.XmlStringMaxLen511"
    ]
    """<p>This is replaced by <code>Identifier</code>.</p>"""
    state: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>Describes the current state of a traffic source.</p> <p>The state values are as follows:</p> <ul> <li> <p> <code>Adding</code> - The Auto Scaling instances are being registered with the load balancer or target group.</p> </li> <li> <p> <code>Added</code> - All Auto Scaling instances are registered with the load balancer or target group.</p> </li> <li> <p> <code>InService</code> - For an Elastic Load Balancing load balancer or target group, at least one Auto Scaling instance passed an <code>ELB</code> health check. For VPC Lattice, at least one Auto Scaling instance passed an <code>VPC_LATTICE</code> health check.</p> </li> <li> <p> <code>Removing</code> - The Auto Scaling instances are being deregistered from the load balancer or target group. If connection draining (deregistration delay) is enabled, Elastic Load Balancing or VPC Lattice waits for in-flight requests to complete before deregistering the instances.</p> </li> <li> <p> <code>Removed</code> - All Auto Scaling instances are deregistered from the load balancer or target group.</p> </li> </ul>"""
    identifier: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len511.XmlStringMaxLen511"
    ]
    """<p>The unique identifier of the traffic source.</p>"""
    type: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len511.XmlStringMaxLen511"
    ]
    """<p>Provides additional context for the value of <code>Identifier</code>.</p> <p>The following lists the valid values:</p> <ul> <li> <p> <code>elb</code> if <code>Identifier</code> is the name of a Classic Load Balancer.</p> </li> <li> <p> <code>elbv2</code> if <code>Identifier</code> is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.</p> </li> <li> <p> <code>vpc-lattice</code> if <code>Identifier</code> is the ARN of a VPC Lattice target group.</p> </li> </ul> <p>Required if the identifier is the name of a Classic Load Balancer.</p>"""

identifier instance-attribute

identifier: NotRequired[XmlStringMaxLen511]

The unique identifier of the traffic source.

state instance-attribute

state: NotRequired[XmlStringMaxLen255]

Describes the current state of a traffic source.

The state values are as follows:

  • Adding - The Auto Scaling instances are being registered with the load balancer or target group.

  • Added - All Auto Scaling instances are registered with the load balancer or target group.

  • InService - For an Elastic Load Balancing load balancer or target group, at least one Auto Scaling instance passed an ELB health check. For VPC Lattice, at least one Auto Scaling instance passed an VPC_LATTICE health check.

  • Removing - The Auto Scaling instances are being deregistered from the load balancer or target group. If connection draining (deregistration delay) is enabled, Elastic Load Balancing or VPC Lattice waits for in-flight requests to complete before deregistering the instances.

  • Removed - All Auto Scaling instances are deregistered from the load balancer or target group.

traffic_source instance-attribute

traffic_source: NotRequired[XmlStringMaxLen511]

This is replaced by Identifier.

type instance-attribute

type: NotRequired[XmlStringMaxLen511]

Provides additional context for the value of Identifier.

The following lists the valid values:

  • elb if Identifier is the name of a Classic Load Balancer.

  • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.

  • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.

Required if the identifier is the name of a Classic Load Balancer.