Amazon EC2 Auto Scaling · JSON Structure

Ec2 Auto Scaling Traffic Source State Structure

Describes the state of a traffic source.

Type: object Properties: 4
Amazon Web ServicesAuto ScalingComputeEC2High AvailabilityScaling

TrafficSourceState is a JSON Structure definition published by Amazon EC2 Auto Scaling, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

TrafficSource State Identifier Type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/json-structure/ec2-auto-scaling-traffic-source-state-structure.json",
  "name": "TrafficSourceState",
  "description": "Describes the state of a traffic source.",
  "type": "object",
  "properties": {
    "TrafficSource": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen511"
        },
        {
          "deprecated": true,
          "description": "This is replaced by <code>Identifier</code>.TrafficSource has been replaced by Identifier"
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "<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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen511"
        },
        {
          "description": "The unique identifier of the traffic source."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen511"
        },
        {
          "description": "<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>"
        }
      ]
    }
  }
}