LoadBalancer

Describes a load balancer

Amazon Web ServicesHigh AvailabilityLoad BalancingNetworkingScalability

Properties

Name	Type	Description
loadBalancerArn	string	The Amazon Resource Name (ARN) of the load balancer
dnsName	string	The public DNS name of the load balancer
canonicalHostedZoneId	string	The ID of the Amazon Route 53 hosted zone for the load balancer
createdTime	string	The date and time the load balancer was created
loadBalancerName	string	The name of the load balancer
scheme	string	The scheme of the load balancer
vpcId	string	The ID of the VPC for the load balancer
state	object	The state of the load balancer
type	string	The type of load balancer
availabilityZones	array	The subnets for the load balancer
securityGroups	array	The IDs of the security groups for the load balancer
ipAddressType	string	The type of IP addresses used by the subnets

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-elastic-load-balancing/refs/heads/main/json-schema/amazon-elastic-load-balancing-load-balancer-schema.json",
  "title": "LoadBalancer",
  "description": "Describes a load balancer",
  "type": "object",
  "properties": {
    "loadBalancerArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the load balancer"
    },
    "dnsName": {
      "type": "string",
      "description": "The public DNS name of the load balancer"
    },
    "canonicalHostedZoneId": {
      "type": "string",
      "description": "The ID of the Amazon Route 53 hosted zone for the load balancer"
    },
    "createdTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the load balancer was created"
    },
    "loadBalancerName": {
      "type": "string",
      "description": "The name of the load balancer"
    },
    "scheme": {
      "type": "string",
      "description": "The scheme of the load balancer",
      "enum": [
        "internet-facing",
        "internal"
      ]
    },
    "vpcId": {
      "type": "string",
      "description": "The ID of the VPC for the load balancer"
    },
    "state": {
      "type": "object",
      "description": "The state of the load balancer",
      "properties": {
        "code": {
          "type": "string",
          "description": "The state code",
          "enum": [
            "active",
            "provisioning",
            "active_impaired",
            "failed"
          ]
        },
        "reason": {
          "type": "string",
          "description": "A description of the state"
        }
      }
    },
    "type": {
      "type": "string",
      "description": "The type of load balancer",
      "enum": [
        "application",
        "network",
        "gateway"
      ]
    },
    "availabilityZones": {
      "type": "array",
      "description": "The subnets for the load balancer",
      "items": {
        "type": "object",
        "properties": {
          "zoneName": {
            "type": "string",
            "description": "The name of the Availability Zone"
          },
          "subnetId": {
            "type": "string",
            "description": "The ID of the subnet"
          }
        }
      }
    },
    "securityGroups": {
      "type": "array",
      "description": "The IDs of the security groups for the load balancer",
      "items": {
        "type": "string"
      }
    },
    "ipAddressType": {
      "type": "string",
      "description": "The type of IP addresses used by the subnets",
      "enum": [
        "ipv4",
        "dualstack"
      ]
    }
  }
}