AWS Excel Definitions

Container Instance ARN

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

EC2 Instance Id

The EC2 instance ID of the container instance.

Status

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

• If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance.

• If the registration fails, the instance will transition to a REGISTRATION_FAILED status.

• Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

• The ACTIVE status indicates that the container instance can accept tasks.

• The DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible.

Agent Connected

This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests.

Agent Version

The version number of the Amazon ECS container agent.

Docker Version

The Docker version running on the container instance.

Registered CPU Units

This parameter describes the amount of CPU resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. 

The conversion of Registered CPU units to vCPU

vCPU= CPU Units/1024

Remaining CPU

This parameter describes the remaining CPU that has not already been allocated to tasks and is therefore available for new tasks.

The conversion of Remaining CPU units to vCPU

vCPU= CPU Units/1024

Registered Memory

This parameter describes the amount of Memory resources that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of memory that can be allocated on this container instance to tasks. 

Remaining Memory

This parameter describes the remaining memory that has not already been allocated to tasks and is therefore available for new tasks.

Running Task Count

The number of tasks on the container instance that are in the RUNNING status.

Pending Task Count

The number of tasks on the container instance that are in the PENDING status.

Capacity Provider Name

The capacity provider associated with the container instance.

Cluster Name

A user-generated string that you use to identify your cluster.

Cluster ARN

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name.

Status

The status of the cluster. The following are the possible states that will be returned.

• ACTIVE: The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

• PROVISIONING: The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

• DEPROVISIONING: The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

• FAILED:The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

• INACTIVE:The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Container Instances Count

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Active EC2 Services Count

The number of EC2 services that are running on the cluster in an ACTIVE state.

Draining EC2 Services Count

The number of EC2 services that are running on the cluster in an DRAININGstate. 

Active Fargate Services Count

The number of Fargate services that are running on the cluster in an ACTIVE state.

Draining Fargate Services Count

The number of Fargate services that are running on the cluster in an DRAININGstate. 

Running EC2 Tasks Count

The number of EC2 Lunched tasks in the cluster that are in the RUNNING state.

Pending EC2 Tasks Count

The number of EC2 Lunched tasks in the cluster that are in the PENDING state.

Running Fargate Tasks Count

The number of Fargate Lunched tasks in the cluster that are in the RUNNING state.

Pending Fargate Tasks Count

The number of Fargate Lunched tasks in the cluster that are in the PENDING state.

Service Name

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Service ARN

The ARN that identifies the service. The ARN contains thearn:aws:ecsnamespace, followed by the Region of the service, the AWS account ID of the service owner, theservicenamespace, and then the service name. For example,arn:aws:ecs:region:012345678910:service/my-service.

Cluster ARN

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Status

The status of the service. The valid values areACTIVE,DRAINING, orINACTIVE.

Launch Type

The launch type on which your service is running. If no value is specified, it will default toEC2. Valid values includeEC2andFARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Possible values include:

• "EC2"
• "FARGATE"

Platform Version

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, theLATESTplatform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Desired Count

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Running Tasks Count

The number of tasks in the cluster that are in theRUNNINGstate.

Pending Tasks Count

The number of tasks in the cluster that are in thePENDINGstate.

Task Definition Name

The name of the task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Task Definition ARN

The ARN of the task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Deployment Maximum Percent

If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in theRUNNINGorPENDINGstate during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in theDRAININGstate if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the blue/green (CODE_DEPLOY) orEXTERNALdeployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNINGstate while the container instances are in theDRAININGstate. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

Deployment Minimum Healthy Percent

If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in theRUNNINGstate during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in theDRAININGstate if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services thatdo notuse a load balancer are considered healthy if they are in theRUNNINGstate; tasks for services that douse a load balancer are considered healthy if they are in theRUNNINGstate and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the blue/green (CODE_DEPLOY) orEXTERNALdeployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNINGstate while the container instances are in theDRAININGstate. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

Capacity Provider Name

The short name of the capacity provider.

Capacity Provider Weight

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

For example, if you have a strategy that contains two capacity providers and both have a weight of1, then when thebaseis satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1forcapacityProviderAand a weight of4forcapacityProviderB, then for every one task that is run using capacity Provider A, four tasks would use capacity Provider B.

Capacity Provider Base

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.

The scheduling strategy to use for the service. There are two service scheduler strategies available:

• REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

• DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.

Note: Fargate tasks do not support theDAEMONscheduling strategy.

The status of the task definition.

• "ACTIVE"
• "INACTIVE"

The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

The number ofcpuunits used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for thememoryparameter:

• 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

• 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

• 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

• 2048 (2 vCPU) - Availablememoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

• 4096 (4 vCPU) - Availablememoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

The conversion of Task CPU units to vCPU

vCPU= CPU Units/1024

The amount (in MiB) of memory used by the task.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see Container Definition.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for thecpuparameter:

• 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU)

• 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU)

• 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU)

• Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU)

• Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU)

The Docker networking mode to use for the containers in the task. The valid values arenone,bridge,awsvpc, andhost. If no network mode is specified, the default isbridge.

The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with eitherrepository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run.

• When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

• Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

• Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo).

• Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent).

• Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu).

The conversion of Container CPU units to vCPU

vCPU= CPU Units/1024

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the taskmemoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.

If using the Fargate launch type, this parameter is optional.

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with thememoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value ofmemoryis used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

The port number on the container instance to reserve for your container.

If you are using containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort.

If you are using containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The protocol used for the port mapping. Valid values aretcpandudp. The default istcp.

• "tcp"
• "udp"

The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

• "EC2"
• "FARGATE"

The connectivity status of a task.

• "CONNECTED"
• "DISCONNECTED"

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example1024. It can also be expressed as a string using vCPUs, for example1 vCPUor1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.

If you are using the EC2 launch type, this field is optional. Supported values are between128CPU units (0.125vCPUs) and10240CPU units (10vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for thememoryparameter:

• 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

• 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

• 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

• 2048 (2 vCPU) - Availablememoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

• 4096 (4 vCPU) - Availablememoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

The conversion of CPU units to vCPU

vCPU= CPU Units/1024

• The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example1024. It can also be expressed as a string using GB, for example1GBor1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.

  If you are using the EC2 launch type, this field is optional.

  If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for thecpuparameter:

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU)

The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting asHEALTHY, then the task status also reports asHEALTHY. If any essential containers in the task are reporting asUNHEALTHYorUNKNOWN, then the task status also reports asUNHEALTHYorUNKNOWN, accordingly.

Possible values include:

• "HEALTHY"
• "UNHEALTHY"
• "UNKNOWN"

The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

• "EC2"
• "FARGATE"

The conversion of CPU units to vCPU

vCPU= CPU Units/1024

The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status asUNKNOWN.

• "HEALTHY"
• "UNHEALTHY"
• "UNKNOWN"

The current status of the capacity provider. Only capacity providers in anACTIVEstate can be used in a cluster. When a capacity provider is successfully deleted, it will have anINACTIVEstatus.

• "ACTIVE"
• "INACTIVE"

Whether or not to enable managed scaling for the capacity provider.

• "ENABLED"
• "DISABLED"

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

Possible values include:

• "ENABLED"
• "DISABLED"

Note

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.

When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.

The current status of the cluster.

• "CREATING"
• "ACTIVE"
• "DELETING"
• "FAILED"
• "UPDATING"

The current status of the managed node group.

• "CREATING"
• "ACTIVE"
• "UPDATING"
• "DELETING"
• "CREATE_FAILED"
• "DELETE_FAILED"
• "DEGRADED"

The capacity type of your managed node group.

Possible values include:

• "ON_DEMAND"
• "SPOT"

The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this isnull.

If the node group was deployed using a launch template with a custom AMI, then this isCUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.

• "AL2_x86_64"

• "AL2_x86_64_GPU"

• "AL2_ARM_64"

The IAM role associated with your node group. The Amazon EKS nodekubeletdaemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.

The health status of the node group. If there are issues with your node group's health

A brief description of the error.

• AccessDenied: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.

• AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.

• AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.

• ClusterUnreachable: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests.

• Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.

• Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.

• Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.

• Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.

• Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable theauto-assign public IP addresssetting for the subnet. 

• IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.

• IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.

• InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.

• InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.

• InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.

• NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes.

The current status of the Fargate profile.

• "CREATING"
• "ACTIVE"
• "DELETING"
• "CREATE_FAILED"
• "DELETE_FAILED"

The current status of the Fargate profile.

• "CREATING"
• "ACTIVE"
• "DELETING"
• "CREATE_FAILED"
• "DELETE_FAILED"

The status of the add-on.

• "CREATING"
• "ACTIVE"
• "CREATE_FAILED"
• "UPDATING"
• "DELETING"
• "DELETE_FAILED"
• "DEGRADED"

An object that represents the health of the add-on.

• "AccessDenied"
• "InternalFailure"
• "ClusterUnreachable"
• "InsufficientNumberOfReplicas"
• "ConfigurationConflict"
• "AdmissionRequestDenied"