Amazon EC2 Auto Scaling · JSON Structure

Ec2 Auto Scaling Auto Scaling Instance Details Structure

Describes an EC2 instance associated with an Auto Scaling group.

Type: object Properties: 10 Required: 6
Amazon Web ServicesAuto ScalingComputeEC2High AvailabilityScaling

AutoScalingInstanceDetails is a JSON Structure definition published by Amazon EC2 Auto Scaling, describing 10 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

InstanceId InstanceType AutoScalingGroupName AvailabilityZone LifecycleState HealthStatus LaunchConfigurationName LaunchTemplate ProtectedFromScaleIn WeightedCapacity

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-auto-scaling-instance-details-structure.json",
  "name": "AutoScalingInstanceDetails",
  "description": "Describes an EC2 instance associated with an Auto Scaling group.",
  "type": "object",
  "properties": {
    "InstanceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen19"
        },
        {
          "description": "The ID of the instance."
        }
      ]
    },
    "InstanceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The instance type of the EC2 instance."
        }
      ]
    },
    "AutoScalingGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The name of the Auto Scaling group for the instance."
        }
      ]
    },
    "AvailabilityZone": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The Availability Zone for the instance."
        }
      ]
    },
    "LifecycleState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen32"
        },
        {
          "description": "<p>The lifecycle state for the instance. The <code>Quarantined</code> state is not used. For information about lifecycle states, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html\">Instance lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p> <p>Valid values: <code>Pending</code> | <code>Pending:Wait</code> | <code>Pending:Proceed</code> | <code>Quarantined</code> | <code>InService</code> | <code>Terminating</code> | <code>Terminating:Wait</code> | <code>Terminating:Proceed</code> | <code>Terminated</code> | <code>Detaching</code> | <code>Detached</code> | <code>EnteringStandby</code> | <code>Standby</code> | <code>Warmed:Pending</code> | <code>Warmed:Pending:Wait</code> | <code>Warmed:Pending:Proceed</code> | <code>Warmed:Terminating</code> | <code>Warmed:Terminating:Wait</code> | <code>Warmed:Terminating:Proceed</code> | <code>Warmed:Terminated</code> | <code>Warmed:Stopped</code> | <code>Warmed:Running</code> </p>"
        }
      ]
    },
    "HealthStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen32"
        },
        {
          "description": "The last reported health status of this instance. <code>Healthy</code> means that the instance is healthy and should remain in service. <code>Unhealthy</code> means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it."
        }
      ]
    },
    "LaunchConfigurationName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group."
        }
      ]
    },
    "LaunchTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LaunchTemplateSpecification"
        },
        {
          "description": "The launch template for the instance."
        }
      ]
    },
    "ProtectedFromScaleIn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceProtected"
        },
        {
          "description": "Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in."
        }
      ]
    },
    "WeightedCapacity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen32"
        },
        {
          "description": "<p>The number of capacity units contributed by the instance based on its instance type.</p> <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>"
        }
      ]
    }
  },
  "required": [
    "InstanceId",
    "AutoScalingGroupName",
    "AvailabilityZone",
    "LifecycleState",
    "HealthStatus",
    "ProtectedFromScaleIn"
  ]
}