Home
Amazon Fargate
Amazon Fargate Service Structure
Amazon Fargate Service Structure
An Amazon ECS service
Type: object
Properties: 13
Compute Containers ECS EKS Microservices Serverless
Service is a JSON Structure definition published by Amazon Fargate, describing 13 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
serviceArn
serviceName
clusterArn
taskDefinition
desiredCount
runningCount
pendingCount
status
launchType
networkConfiguration
loadBalancers
createdAt
tags
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-fargate/refs/heads/main/json-structure/amazon-fargate-service-structure.json",
"description": "An Amazon ECS service",
"type": "object",
"properties": {
"serviceArn": {
"type": "string",
"description": "ARN of the service",
"example": "arn:aws:ecs:us-east-1:123456789012:service/my-fargate-cluster/my-fargate-service"
},
"serviceName": {
"type": "string",
"description": "Name of the service",
"example": "my-fargate-service"
},
"clusterArn": {
"type": "string",
"description": "ARN of the cluster",
"example": "arn:aws:ecs:us-east-1:123456789012:cluster/my-fargate-cluster"
},
"taskDefinition": {
"type": "string",
"description": "Task definition ARN or family:revision",
"example": "my-fargate-task:1"
},
"desiredCount": {
"type": "int32",
"description": "Desired number of tasks",
"example": 2
},
"runningCount": {
"type": "int32",
"description": "Number of running tasks",
"example": 2
},
"pendingCount": {
"type": "int32",
"description": "Number of pending tasks",
"example": 0
},
"status": {
"type": "string",
"description": "Service status",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"DRAINING",
"INACTIVE"
]
},
"launchType": {
"type": "string",
"description": "Launch type",
"example": "FARGATE"
},
"networkConfiguration": {
"$ref": "#/components/schemas/NetworkConfiguration"
},
"loadBalancers": {
"type": "array",
"description": "Load balancer configurations",
"items": {
"$ref": "#/components/schemas/LoadBalancer"
}
},
"createdAt": {
"type": "datetime",
"description": "Service creation time"
},
"tags": {
"type": "array",
"description": "Tags",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
},
"name": "Service"
}