AWS ECS Service Tables

The AWS ECS Service uses the following tables

Tables

AWSECSAttachmentDetails

NameTypeDescription
NamestringThe name of the key-value pair. For environment variables, this is the name of the environment variable.
ValuestringThe value of the key-value pair. For environment variables, this is the value of the environment variable.
AWSECSAttachmentIDstringThe unique identifier for the attachment.
IDintegerThe ID of the attachment detail.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSAttachments

NameTypeDescription
AWSECSClusterConfigIDintegerA unique identifier for the configuration associated with the cluster config
AWSECSContainerInstanceConfigIDintegerA unique identifier for the configuration associated with the container instance config
AWSECSTaskConfigIDintegerA unique identifier for the configuration associated with the task config
StatusstringThe status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.
TypestringThe type of the attachment, such as ElasticNetworkInterface, Service Connect, and AmazonElasticBlockStorage.
IDstringThe ID of the attachment.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.
AWSECSContainerInstanceARNstringThe ARN of the container instances that host the task.
AWSECSTaskARNstringThe ARN of the task.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSCapacityProviderStrategies

NameTypeDescription
AWSECSClusterConfigIDintegerA unique identifier for the configuration associated with the cluster config
AWSECSDeploymentConfigIDintegerA unique identifier for the configuration associated with the deployment config
AWSECSServiceConfigIDintegerA unique identifier for the configuration associated with the service config
AWSECSTaskSetConfigIDintegerA unique identifier for the configuration associated with the task set config
BaseintegerThe 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. If no value is specified, the default value of 0 is used.
WeightintegerThe weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
AWSECSDeploymentIDstringThe ID of the deployment.
CapacityProviderstringThe short name of the capacity provider.
IDintegerThe ID of the capacity provider.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.
AWSECSServiceARNstringThe ARN of the service.
AWSECSTaskSetARNstringThe ARN of the task set that hosts the service.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSClusters

NameTypeDescription
ActiveServicesCountintegerThe number of services that are running on the cluster in an ACTIVE state.
ARNstringThe ARN of the cluster that hosts the service.
AttachmentsStatusstringThe status of the capacity providers associated with the cluster. The following are the states that are returned: UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED,
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
CapacityProvidersJsonstringThe capacity providers associated with the cluster.
CloudWatchEncryptionEnabledbitDetermines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
CloudWatchLogGroupNamestringThe name of the CloudWatch log group to send logs to.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
FargateEphemeralStorageKMSKeyIDstringSpecify the AWS Key Management Service key ID for the Fargate ephemeral storage.
LoggingstringThe log setting to use for redirecting logs for your execute command results. The following log settings are available: NONE, DEFAULT, OVERRIDE
LoggingKMSKeyIDstringSpecify a AWS Key Management Service key ID to encrypt your logs.
ManagedStorageKMSKeyIDstringSpecify a AWS Key Management Service key ID to encrypt the managed storage.
NamestringA user-generated string that you use to identify your cluster.
PendingTasksCountintegerThe number of tasks in the cluster that are in the PENDING state.
RegisteredContainerInstancesCountintegerThe number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
RunningTasksCountintegerThe number of tasks in the cluster that are in the RUNNING state.
S3BucketNamestringThe name of the S3 bucket to send logs to.
S3EncryptionEnabledbitDetermines whether to use encryption on the S3 logs. If not specified, encryption is not used.
S3KeyPrefixstringAn optional folder in the S3 bucket to place logs in.
ServiceConnectDefaultsNamespacestringUse this parameter to set a default Service Connect namespace.
StatusstringThe status of the cluster. The following are the possible states that are returned: ACTIVE, PROVISIONING, DEPROVISIONING, FAILED, INACTIVE

AWSECSClusterSettings

NameTypeDescription
NamestringThe name of the cluster setting. The value is containerInsights.
ValuestringThe value to set for the cluster setting. The supported values are enhanced, enabled, and disabled.
IDintegerThe ID of the cluster setting.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSClusterStatistics

NameTypeDescription
NamestringThe name of the key-value pair. For environment variables, this is the name of the environment variable.
ValuestringThe value of the key-value pair. For environment variables, this is the value of the environment variable.
IDintegerThe ID of the cluster statistic.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSContainerInstances

NameTypeDescription
AgentConnectedbitThis parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.
AgentHashstringThe Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
AgentUpdateStatusstringThe status of the most recent agent update. If an update wasn't ever requested, this value is NULL. Valid Values: PENDING, STAGING, STAGED, UPDATING, UPDATED, FAILED
AgentVersionstringThe version number of the Amazon ECS container agent.
ARNstringThe ARN of the Container Instance.
AttributesJsonstringThe attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
CapacityProviderNamestringThe capacity provider that's associated with the container instance.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
DockerVersionstringThe Docker version that's running on the container instance
IDstringThe ID of the container instance.
OverallHealthStatusstringAn object representing the health status of the container instance.
PendingTasksCountintegerThe number of tasks on the container instance that are in the PENDING status.
RegisteredAtdatetimeThe Unix timestamp for the time when the container instance was registered.
RunningTasksCountintegerThe number of tasks on the container instance that have a desired status (desiredStatus) of RUNNING.
StatusstringThe status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.
StatusReasonstringThe reason that the container instance reached its current status.
VersionbigintThe version counter for the container instance.

AWSECSContainerOverrides

NameTypeDescription
CommandsJsonstringThe command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
CpuintegerThe number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
MemoryintegerThe hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
MemoryReservationintegerThe soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
NamestringThe name of the container that receives the override. This parameter is required if any override is specified.
IDintegerThe ID of the container override.
AWSECSTaskARNstringThe ARN of the task.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSContainers

NameTypeDescription
ARNstringThe ARN of the container.
AWSECSTaskARNstringThe ARN of the task.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
CpustringThe number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.
ExitCodeintegerThe exit code returned from the container.
GpuIDsJsonstringThe IDs of each GPU assigned to the container.
HealthStatusstringThe health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN. Valid values are: HEALTHY, UNHEALTHY, UNKOWN
ImagestringThe image used for the container.
ImageDigeststringThe container image manifest digest.
LastStatusstringThe last known status of the container.
MemorystringThe hard limit (in MiB) of memory set for the container.
MemoryReservationstringThe soft limit (in MiB) of memory set for the container.
NamestringThe name of the container.
ReasonstringA short (255 max characters) human-readable string to provide additional details about a running or stopped container.
RuntimeIDstringThe ID of the Docker container.

AWSECSDeployments

NameTypeDescription
AWSECSServiceARNstringThe ARN of the service.
AWSVPCAssignPublicIpstringWhether the task's elastic network interface receives a public IP address. Valid values: ENABLED, DISABLED
AWSVPCSecurityGroupsJsonstringThe IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified.
AWSVPCSubnetsJsonstringThe IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
CreatedAtdatetimeThe Unix timestamp for the time when the service deployment was created.
DesiredCountintegerThe most recent desired count of tasks that was specified for the service to deploy or maintain.
FailedTasksintegerThe number of consecutively failed tasks in the deployment.
FargateEphemeralStorageKMSKeyIDstringSpecify the AWS Key Management Service key ID for the Fargate ephemeral storage.
IDstringThe ID of the deployment.
LaunchTypestringThe launch type the tasks in the service are using.
PendingCountintegerThe number of tasks in the deployment that are in the PENDING status.
PlatformFamilystringThe operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.
PlatformVersionstringThe platform version that your tasks in the service run on.
RolloutStatestringThe rollout state of the deployment. Valid values: COMPLETED, FAILED, IN_PROGRESS
RolloutStateReasonstringA description of the rollout state of a deployment.
RunningCountintegerThe number of tasks in the deployment that are in the RUNNING status.
ServiceConnectEnabledbitThe details of the Service Connect configuration that's used by this deployment.
ServiceConnectLogDriverstringThe log driver to use for the container. Valid values: json-file, syslog, journald, gelf, fluentd, awslogs, splunk, `awsfirelens
ServiceConnectLogOptionsJsonstringThe configuration options to send to the log driver.
ServiceConnectLogSecretOptionsJsonstringThe secrets to pass to the log configuration.
ServiceConnectNamespacestringThe namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace to list the services in.
StatusstringThe status of the deployment. Valid values: PRIMARY, ACTIVE, INACTIVE
TaskDefinitionstringThe most recent task definition that was specified for the tasks in the service to use.
UpdatedAtdatetimeThe Unix timestamp for the time when the service deployment was last updated.

AWSECSEnvironmentFiles

NameTypeDescription
AWSECSContainerOverrideConfigIDintegerA unique identifier for the configuration associated with the container override configuration.
TypestringThe file type to use. Environment files are objects in Amazon S3. The only supported value is s3.
ValuestringThe ARN of the Amazon S3 object containing the environment variable file.
AWSECSContainerOverrideIDintegerA unique identifier for the configuration associated with the container override.
IDintegerThe ID of the environment file.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSEnvironments

NameTypeDescription
AWSECSContainerOverrideConfigIDintegerA unique identifier for the configuration associated with the container override configuration.
NamestringThe Amazon ECS resource name.
ValuestringDetermines whether the account setting is on or off for the specified resource.
AWSECSContainerOverrideIDintegerA unique identifier for the configuration associated with the container override.
IDintegerThe ID of the environment.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSFailures

NameTypeDescription
AWSECSClusterConfigIDintegerA unique identifier for the configuration associated with the cluster config
ARNstringThe ARN of the failed resource.
AWSECSContainerInstanceConfigIDintegerA unique identifier for the configuration associated with the container instance config
AWSECSServiceConfigIDintegerA unique identifier for the configuration associated with the service config
AWSECSTaskConfigIDintegerA unique identifier for the configuration associated with the task config
DetailstringThe details of the failure.
ReasonstringThe reason for the failure.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.
IDintegerThe ID of the failure.
AWSECSContainerInstanceARNstringThe ARN of the container instances that host the task.
AWSECSServiceARNstringThe ARN of the service.
AWSECSTaskARNstringThe ARN of the task.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSInferenceAcceleratorOverrides

NameTypeDescription
DeviceNamestringThe Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
DeviceTypestringThe Elastic Inference accelerator type to use.
IDintegerThe ID of the inference accelerator override.
AWSECSTaskARNstringThe ARN of the task.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSInferenceAccelerators

NameTypeDescription
DeviceNamestringThe Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
DeviceTypestringThe Elastic Inference accelerator type to use.
IDintegerThe ID of the inference accelerator.
AWSECSTaskARNstringThe ARN of the task.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSInstanceHealthCheckResults

NameTypeDescription
LastStatusChangedatetimeThe Unix timestamp for when the container instance health status last changed.
StatusstringThe container instance health status. Valid values: OK, IMPAIRED, INSUFFICIENT_DATA, INITIALIZING
LastUpdateddatetimeThe Unix timestamp for when the container instance health status was last updated.
TypestringThe type of container instance health status that was verified.
IDintegerThe ID of the health check result.
AWSECSContainerInstanceARNstringThe ARN of the container instances that host the task.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSLoadBalancers

NameTypeDescription
AWSECSServiceConfigIDintegerA unique identifier for the configuration associated with the service config
AWSECSTaskSetConfigIDintegerA unique identifier for the configuration associated with the task set config
ContainerNamestringThe name of the container (as it appears in a container definition) to associate with the load balancer.
ContainerPortintegerThe port on the container to associate with the load balancer.
NamestringThe name of the load balancer to associate with the Amazon ECS service or task set.
IDintegerThe ID of the load balancer.
AWSECSServiceARNstringThe ARN of the service.
AWSECSTaskSetARNstringThe ARN of the task set that hosts the service.
TargetGroupARNstringThe full ARN of the Elastic Load Balancing target group or groups associated with a service or task set.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSManagedAgents

NameTypeDescription
LastStartedAtdatetimeThe Unix timestamp for the time when the managed agent was last started.
LastStatusstringThe last known status of the managed agent.
NamestringThe name of the managed agent. When the execute command feature is turned on, the managed agent name is ExecuteCommandAgent.
ReasonstringThe reason for why the managed agent is in the state it is in.
AWSECSContainerARNstringThe ARN of the container.
IDintegerThe ID of the managed asset.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSNetworkBindings

NameTypeDescription
BindIPstringThe IP address that the container is bound to on the container instance.
ContainerPortintegerThe port number on the container that's used with the network binding.
ContainerPortRangestringThe port number range on the container that's bound to the dynamically mapped host port range.
HostPortintegerThe port number on the host that's used with the network binding.
HostPortRangestringThe port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.
ProtocolstringThe protocol used for the network binding.
AWSECSContainerARNstringThe ARN of the container.
IDintegerThe ID of the network binding.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSNetworkInterfaces

NameTypeDescription
Ipv6AddressstringThe private IPv6 address for the network interface.
PrivateIpv4AddressstringThe private IPv4 address for the network interface.
AWSECSContainerARNstringThe ARN of the container.
AttachmentIDstringThe attachment ID for the network interface.
IDintegerThe ID of the network interface.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSPlacementConstraints

NameTypeDescription
ExpressionstringA cluster query language expression to apply to the constraint.
TypestringThe type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
IDintegerThe ID of the placement constraint.
AWSECSServiceARNstringThe ARN of the service.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSPlacementStrategies

NameTypeDescription
FieldstringThe field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
TypestringThe type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.
IDintegerThe ID of the placement strategy.
AWSECSServiceARNstringThe ARN of the service.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSResources

NameTypeDescription
AWSECSContainerInstanceConfigIDintegerA unique identifier for the configuration associated with the container instance config
DoubleValuefloatWhen the doubleValue type is set, the value of the resource must be a double precision floating-point type.
IntegerValueintegerWhen the integerValue type is set, the value of the resource must be an integer.
LongValuebigintWhen the longValue type is set, the value of the resource must be an extended precision floating-point type.
NamestringThe name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.
TypestringThe type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.
IsRemainingbitNEED DESCRIPTION
IsRegisteredbitNEED DESCRIPTION
StringSetValueJsonstringWhen the stringSetValue type is set, the value of the resource must be a string type.
AWSECSContainerInstanceARNstringThe ARN of the container instances that host the task.
IDintegerThe ID of the resource.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSServiceConnectClientAliases

NameTypeDescription
AWSECSServiceConnectServiceConfigIDintegerA unique identifier for the configuration associated with the service config
DNSNamestringThe dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified.
PortintegerThe listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
AWSECSServiceConnectServiceIDintegerThe ID of the service connect service.
IDintegerThe ID of the Service Connect client alias.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSServiceConnectResources

NameTypeDescription
DiscoveryNamestringThe discovery name of this Service Connect resource.
AWSECSDeploymentIDstringThe ID of the deployment.
IDintegerThe ID of the Service Connect resource.
DiscoveryARNstringThe ARN for the namespace in AWS Cloud Map that matches the discovery name for this Service Connect resource.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSServiceConnectServices

NameTypeDescription
DiscoveryNamestringThe discoveryName is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service.
PortNamestringThe portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
PerRequestTimeoutSecondsintegerThe amount of time waiting for the upstream to respond with a complete response per request. A value of 0 can be set to disable perRequestTimeout.
TLSKMSKeystringThe AWS Key Management Service key.
AWSECSDeploymentIDstringThe ID of the deployment.
IDintegerThe ID of the service connect service.
IdleTimeoutSecondsintegerThe amount of time in seconds a connection will stay active while idle. A value of 0 can be set to disable idleTimeout.
IngressPortOverrideintegerThe port number for the Service Connect proxy to listen on.
AWSPCAAuthorityAARNstringThe ARN of the AWS Private Certificate Authority certificate.
TLSRoleARNstringThe ARN of the IAM role that's associated with the Service Connect TLS.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSServiceEvents

NameTypeDescription
CreatedAtdatetimeThe Unix timestamp for the time when the event was triggered.
MessagestringThe event message.
AWSECSServiceARNstringThe ARN of the service.
IDstringThe ID string for the event.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSServiceRegistries

NameTypeDescription
ARNstringThe ARN of the service registry.
AWSECSServiceConfigIDintegerA unique identifier for the configuration associated with the service config
AWSECSTaskSetConfigIDintegerA unique identifier for the configuration associated with the task set config
ContainerNamestringThe container name value to be used for your service discovery service. It's already specified in the task definition.
ContainerPortintegerThe port value to be used for your service discovery service.
PortintegerThe port value used if your service discovery service specified an SRV record.
AWSECSServiceARNstringThe ARN of the service.
AWSECSTaskSetARNstringThe ARN of the task set that hosts the service.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSECSServices

NameTypeDescription
ARNstringThe ARN of the service.
AvailabilityZoneRebalancingstringIndicates whether to use Availability Zone rebalancing for the service.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.
AWSVPCAssignPublicIpstringWhether the task's elastic network interface receives a public IP address. Valid values: ENABLED, DISABLED
AWSVPCSecurityGroupsJsonstringThe IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified.
AWSVPCSubnetsJsonstringThe IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
ClusterARNstringThe ARN of the cluster that hosts the service.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
CreatedAtdatetimeThe Unix timestamp for the time when the service was created.
CreatedBystringThe principal that created the service.
DeploymentAlarmNamesJsonstringOne or more CloudWatch alarm names. Use a "," to separate the alarms.
DeploymentAlarmsEnablebitDetermines whether to use the CloudWatch alarm option in the service deployment process.
DeploymentAlarmsRollbackbitDetermines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentCircuitBreakerEnablebitDetermines whether to use the deployment circuit breaker logic for the service.
DeploymentCircuitBreakerRollbackbitDetermines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentControllerTypestringThe deployment controller type to use. Valid values: ECS, CODE_DEPLOY, EXTERNAL
DeploymentMaximumPercentintegerIf a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer).
DeploymentMinimumHealthyPercentintegerIf a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer).
DesiredCountintegerThe desired number of instantiations of the task definition to keep running on the service.
EnableECSManagedTagsbitDetermines whether to use Amazon ECS managed tags for the tasks in the service.
EnableExecuteCommandbitDetermines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
HealthCheckGracePeriodSecondsintegerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
LaunchTypestringThe launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy. Valid values: EC2, FARGATE, EXTERNAL
NamestringThe name of the service.
PendingCountintegerThe number of tasks in the cluster that are in the PENDING state.
PlatformFamilystringThe operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
PlatformVersionstringThe platform version to run your service on.
PropagateTagsstringDetermines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated. Valid values: TASK_DEFINITION, SERVICE, NONE
RoleARNstringThe ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
RunningCountintegerThe number of tasks in the cluster that are in the RUNNING state.
SchedulingStrategystringThe scheduling strategy to use for the service. The scheduling strategy to use for the service: REPLICA and DAEMON
StatusstringThe status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
TaskDefinitionstringThe task definition to use for tasks in the service.

AWSECSTasks

NameTypeDescription
ARNstringThe ARN of the task.
AvailabilityZonestringThe Availability Zone for the task.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
CapacityProviderNamestringThe capacity provider that's associated with the task.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
ConnectivitystringThe connectivity status of a task. Valid Values: CONNECTED, DISCONNECTED
ConnectivityAtdatetimeThe Unix timestamp for the time when the task last went into CONNECTED status.
ContainerInstanceARNstringThe ARN of the container instances that host the task.
CpustringThe number of CPU units used by the task as expressed in a task definition.
CreatedAtdatetimeThe Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.
DesiredStatusstringThe desired status of the task.
EnableExecuteCommandbitDetermines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.
EphemeralStorageSizeInGiBintegerThe total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
ExecutionStoppedAtdatetimeThe Unix timestamp for the time when the task execution stopped.
FargateEphemeralStorageKMSKeyIDstringSpecify the AWS Key Management Service key ID for the Fargate ephemeral storage.
FargateEphemeralStorageSizeInGiBintegerSpecify the total amount, in GiB, of Fargate ephemeral storage.
GroupstringThe name of the task group that's associated with the task.
HealthStatusstringThe health status of the task. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN. Valid values are: HEALTHY, UNHEALTHY, UNKOWN
LastStatusstringThe last known status for the task.
LaunchTypestringThe infrastructure where your task runs on.
MemorystringThe amount of memory (in MiB) that the task uses as expressed in a task definition.
OverridesCpustringThe CPU override for the task.
OverridesEphemeralStorageSizeInGiBintegerThe ephemeral storage setting override for the task in GiB.
OverridesExecutionRoleARNstringThe ARN of the task execution role override for the task.
OverridesMemorystringThe memory override for the task.
PlatformFamilystringThe operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.
PlatformVersionstringThe platform version where your task runs on.
PullStartedAtdatetimeThe Unix timestamp for the time when the container image pull began.
PullStoppedAtdatetimeThe Unix timestamp for the time when the container image pull completed.
StartedAtdatetimeThe Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.
StartedBystringThe tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.
StopCodestringThe stop code indicating why a task was stopped. The stoppedReason might contain additional details.
StoppedAtdatetimeThe Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.
StoppedReasonstringThe reason that the task was stopped.
StoppingAtdatetimeThe Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPING.
TaskDefinitionARNstringThe ARN of the task definition that creates the task.
TaskRoleARNstringThe ARN of the task role that creates the task.
VersionbigintThe version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented.

AWSECSTaskSets

NameTypeDescription
ARNstringThe ARN of the task set.
AWSECSServiceARNstringThe ARN of the service.
AWSVPCAssignPublicIpstringWhether the task's elastic network interface receives a public IP address. Valid values: ENABLED, DISABLED
AWSVPCSecurityGroupsJsonstringThe IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified.
AWSVPCSubnetsJsonstringThe IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
ClusterARNstringThe ARN of the cluster that hosts the service.
ComputedDesiredCountintegerThe computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
CreatedAtdatetimeThe Unix timestamp for the time when the task set was created.
ExternalIDstringThe external ID associated with the task set.
FargateEphemeralStorageKMSKeyIDstringSpecify the AWS Key Management Service key ID for the Fargate ephemeral storage.
IDstringThe ID of the task set.
LaunchTypestringThe launch type the tasks in the task set are using.
PendingCountintegerThe number of tasks in the task set that are in the PENDING status during a deployment.
PlatformFamilystringThe operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.
PlatformVersionstringThe AWS Fargate platform version where the tasks in the task set are running.
RunningCountintegerThe number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
ScaleUnitstringThe unit of measure for the scale value.
ScaleValuefloatThe value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.
StabilityStatusstringThe stability status. This indicates whether the task set has reached a steady state. Valid values are STEAD_STATE, STABILIZING
StabilityStatusAtdatetimeThe Unix timestamp for the time when the task set stability status was retrieved.
StartedBystringThe tag specified when a task set is started. If an AWS CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.
StatusstringThe status of the task set. The following describes each state. Valid values: PRIMARY, ACTIVE, DRAINING
TaskDefinitionstringThe task definition that the task set is using.
UpdatedAtdatetimeThe Unix timestamp for the time when the task set was last updated.

AWSECSVolumeConfigurations

NameTypeDescription
ManagedEBSVolumeEncryptedbitIndicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default.
ManagedEBSVolumeFilesystemTypestringThe Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. Valid Values: ext3, ext4, xfs, ntfs
ManagedEBSVolumeIopsintegerThe number of I/O operations per second (IOPS).
ManagedEBSVolumeSizeInGiBintegerThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.
ManagedEBSVolumeThroughputintegerThe throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
ManagedEBSVolumeTypestringThe volume type.
VolumeNamestringThe volume name.
AWSECSDeploymentIDstringThe ID of the ECS Deployment.
IDintegerThe ID of the volume configuration.
ManagedEBSVolumeKMSKeyIDstringThe ARN identifier of the AWS Key Management Service key to use for Amazon EBS encryption.
ManagedEBSVolumeSnapshotIDstringThe snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size.
ManagedEBSVolumeRoleARNstringThe ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

AWSVPCLatticeConfigurations

NameTypeDescription
RoleARNstringThe ARN of the IAM role to associate with this VPC Lattice configuration.
TargetGroupARNstringThe full ARN of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to.
PortNamestringThe name of the port mapping to register in the VPC Lattice target group.
AWSECSDeploymentIDstringThe ID of the ECS Deployment.
IDintegerThe ID of the VPC lattice configuration.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded

Bridge Table

AWSECSClusters_AWSECSClusterSettings

NameTypeDescription
AWSECSClusterConfigIDintegerA unique identifier for the configuration associated with the cluster config
AWSECSClusterSettingConfigIDintegerThe ID of the cluster setting configuration.
AWSECSClusterSettingIDintegerThe ID of the cluster setting.
AWSECSClusterARNstringThe ARN of the cluster that hosts the service.

Did this page help you?