AWS Elastic Beanstalk Environment is a JSON Structure definition published by Amazon Elastic Beanstalk, describing 21 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://api.apis.io/schemas/amazon-elastic-beanstalk-environment.json",
"name": "AWS Elastic Beanstalk Environment",
"description": "Schema representing an AWS Elastic Beanstalk environment, which is a collection of AWS resources running an application version deployed on a specific platform.",
"type": "object",
"required": [
"ApplicationName"
],
"properties": {
"EnvironmentId": {
"type": "string",
"description": "The ID of this environment.",
"pattern": "^e-[a-z0-9]+$"
},
"EnvironmentName": {
"type": "string",
"description": "The name of this environment.",
"minLength": 4,
"maxLength": 40
},
"EnvironmentArn": {
"type": "string",
"description": "The ARN of this environment.",
"pattern": "^arn:aws[a-zA-Z-]*:elasticbeanstalk:[a-z0-9-]+:[0-9]{12}:environment/.+/.+$"
},
"ApplicationName": {
"type": "string",
"description": "The name of the application associated with this environment.",
"minLength": 1,
"maxLength": 100
},
"VersionLabel": {
"type": "string",
"description": "The application version deployed in this running environment."
},
"SolutionStackName": {
"type": "string",
"description": "The name of the SolutionStack deployed with this environment."
},
"PlatformArn": {
"type": "string",
"description": "The ARN of the platform version."
},
"TemplateName": {
"type": "string",
"description": "The name of the configuration template used to originally launch this environment."
},
"Description": {
"type": "string",
"description": "Describes this environment.",
"maxLength": 200
},
"EndpointURL": {
"type": "string",
"description": "For load-balanced, autoscaling environments, the URL to the LoadBalancer."
},
"CNAME": {
"type": "string",
"description": "The URL to the CNAME for this environment."
},
"DateCreated": {
"type": "datetime",
"description": "The creation date for this environment."
},
"DateUpdated": {
"type": "datetime",
"description": "The last modified date for this environment."
},
"Status": {
"type": "string",
"description": "The current operational status of the environment.",
"enum": [
"Aborting",
"Launching",
"Updating",
"LinkingFrom",
"LinkingTo",
"Ready",
"Terminating",
"Terminated"
]
},
"AbortableOperationInProgress": {
"type": "boolean",
"description": "Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel."
},
"Health": {
"type": "string",
"description": "Describes the health status of the environment.",
"enum": [
"Green",
"Yellow",
"Red",
"Grey"
]
},
"HealthStatus": {
"type": "string",
"description": "Returns the health status of the application running in your environment.",
"enum": [
"NoData",
"Unknown",
"Pending",
"Ok",
"Info",
"Warning",
"Degraded",
"Severe",
"Suspended"
]
},
"Tier": {
"type": "object",
"description": "Describes the current tier of this environment.",
"properties": {
"Name": {
"type": "string",
"description": "The name of this environment tier.",
"enum": [
"WebServer",
"Worker"
]
},
"Type": {
"type": "string",
"description": "The type of this environment tier.",
"enum": [
"Standard",
"SQS/HTTP"
]
},
"Version": {
"type": "string",
"description": "The version of this environment tier."
}
}
},
"Resources": {
"type": "object",
"description": "The description of the AWS resources used by this environment.",
"properties": {
"LoadBalancer": {
"type": "object",
"properties": {
"LoadBalancerName": {
"type": "string",
"description": "The name of the LoadBalancer."
},
"Domain": {
"type": "string",
"description": "The domain name of the LoadBalancer."
},
"Listeners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Protocol": {
"type": "string"
},
"Port": {
"type": "int32"
}
}
}
}
}
}
}
},
"EnvironmentLinks": {
"type": "array",
"description": "A list of links to other environments in the same group.",
"items": {
"type": "object",
"properties": {
"LinkName": {
"type": "string",
"description": "The name of the link."
},
"EnvironmentName": {
"type": "string",
"description": "The name of the linked environment."
}
}
}
},
"OperationsRole": {
"type": "string",
"description": "The Amazon Resource Name (ARN) of the environment's operations role."
}
}
}