String clusterArn
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. For example,
arn:aws:ecs:region:012345678910:cluster/test
..
String clusterName
A user-generated string that you use to identify your cluster.
String status
The status of the cluster. The valid values are ACTIVE or
INACTIVE. ACTIVE indicates that you can
register container instances with the cluster and the associated
instances can accept tasks.
Integer registeredContainerInstancesCount
The number of container instances registered into the cluster.
Integer runningTasksCount
The number of tasks in the cluster that are in the RUNNING
state.
Integer pendingTasksCount
The number of tasks in the cluster that are in the PENDING
state.
Integer activeServicesCount
The number of services that are running on the cluster in an
ACTIVE state. You can view these services with
ListServices.
String containerArn
The Amazon Resource Name (ARN) of the container.
String taskArn
The Amazon Resource Name (ARN) of the task.
String name
The name of the container.
String lastStatus
The last known status of the container.
Integer exitCode
The exit code returned from the container.
String reason
A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.
com.amazonaws.internal.SdkInternalList<T> networkBindings
The network bindings associated with the container.
String name
The name of a container. If you are linking multiple containers together
in a task definition, the name of one container can be
entered in the links of another container to connect the
containers. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed. This parameter maps to
name in the Create a container section of the Docker Remote API and the --name option to docker run.
String image
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
repository-url/image:tag . Up to 255
letters (uppercase and lowercase), numbers, hyphens, underscores, colons,
periods, forward slashes, and number signs are allowed. This parameter
maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in official repositories on Docker Hub use a single name (for
example, ubuntu or mongo).
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).
Integer cpu
The number of cpu units reserved for the container. A
container instance has 1,024 cpu units for every CPU core.
This parameter specifies the minimum amount of CPU to reserve for a
container, and containers share unallocated CPU units with other
containers on the instance with the same ratio as their allocated amount.
This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
Integer memory
The hard limit (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is
killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
You must specify a non-zero integer for one or both of
memory or memoryReservation in container
definitions. If you specify both, memory must be greater
than memoryReservation. If you specify
memoryReservation, then that value is subtracted from the
available memory resources for the container instance on which the
container is placed; otherwise, the value of memory is used.
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.
Integer memoryReservation
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
the memory parameter (if applicable), or all of the
available memory on the container instance, whichever comes first. This
parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option
to docker
run.
You must specify a non-zero integer for one or both of
memory or memoryReservation in container
definitions. If you specify both, memory must be greater
than memoryReservation. If you specify
memoryReservation, then that value is subtracted from the
available memory resources for the container instance on which the
container is placed; otherwise, the value of memory is 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 a memoryReservation of 128 MiB, and a
memory hard 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.
com.amazonaws.internal.SdkInternalList<T> links
The link parameter allows containers to communicate with
each other without the need for port mappings, using the
name parameter and optionally, an alias for the
link. This construct is analogous to name:alias in Docker
links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed for each name and alias
. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps
to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
com.amazonaws.internal.SdkInternalList<T> portMappings
The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send or
receive traffic. This parameter maps to PortBindings in the
Create a container section of the Docker Remote API and the --publish option to docker run.
If the network mode of a task definition is set to none,
then you cannot specify port mappings. If the network mode of a task
definition is set to host, then host ports must either be
undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a selected
task in the Amazon ECS console, or the networkBindings
section DescribeTasks responses.
Boolean essential
If the essential parameter of a container is marked as
true, and that container fails or stops for any reason, all
other containers that are part of the task are stopped. If the
essential parameter of a container is marked as
false, then its failure does not affect the rest of the
containers in a task. If this parameter is omitted, a container is
assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
com.amazonaws.internal.SdkInternalList<T> entryPoint
Early versions of the Amazon ECS container agent do not properly handle
entryPoint parameters. If you have problems using
entryPoint, update your container agent or enter your
commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to
Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run.
For more information, see https://docs.docker.com/reference/builder/#entrypoint.
com.amazonaws.internal.SdkInternalList<T> command
The command that is passed to the container. This parameter maps to
Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run.
For more information, see https://docs.docker.com/reference/builder/#cmd.
com.amazonaws.internal.SdkInternalList<T> environment
The environment variables to pass to a container. This parameter maps to
Env in the Create a container section of the Docker Remote API and the --env option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
com.amazonaws.internal.SdkInternalList<T> mountPoints
The mount points for data volumes in your container. This parameter maps
to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
com.amazonaws.internal.SdkInternalList<T> volumesFrom
Data volumes to mount from another container. This parameter maps to
VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
String hostname
The hostname to use for your container. This parameter maps to
Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
String user
The user name to use inside the container. This parameter maps to
User in the Create a container section of the Docker Remote API and the --user option to docker run.
String workingDirectory
The working directory in which to run commands inside the container. This
parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
Boolean disableNetworking
When this parameter is true, networking is disabled within the container.
This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
Boolean privileged
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root user).
This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
Boolean readonlyRootFilesystem
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only option to
docker run.
com.amazonaws.internal.SdkInternalList<T> dnsServers
A list of DNS servers that are presented to the container. This parameter
maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
com.amazonaws.internal.SdkInternalList<T> dnsSearchDomains
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
com.amazonaws.internal.SdkInternalList<T> extraHosts
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. This parameter maps to
ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
com.amazonaws.internal.SdkInternalList<T> dockerSecurityOptions
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This parameter maps to
SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true or
ECS_APPARMOR_CAPABLE=true environment variables before
containers placed on that instance can use these security options. For
more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
Map<K,V> dockerLabels
A key/value map of labels to add to the container. This parameter maps to
Labels in the Create a container section of the Docker Remote API and the --label option to docker run.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
com.amazonaws.internal.SdkInternalList<T> ulimits
A list of ulimits to set in the container. This parameter
maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
Valid naming values are displayed in the Ulimit data type. This
parameter requires version 1.18 of the Docker Remote API or greater on
your container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
LogConfiguration logConfiguration
The log configuration specification for the container. This parameter
maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run.
By default, containers use the same logging driver that the Docker daemon
uses; however the container may use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance (or
on a different log server for remote logging options). For more
information on the options for different supported log drivers, see Configure
logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before
containers placed on that instance can use these log configuration
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
String containerInstanceArn
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
.
String ec2InstanceId
The EC2 instance ID of the container instance.
VersionInfo versionInfo
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
com.amazonaws.internal.SdkInternalList<T> remainingResources
The remaining resources of the container instance that are available for new tasks.
com.amazonaws.internal.SdkInternalList<T> registeredResources
The registered resources on the container instance that are in use by current tasks.
String status
The status of the container instance. The valid values are
ACTIVE or INACTIVE. ACTIVE
indicates that the container instance can accept tasks.
Boolean agentConnected
This parameter returns true if the agent is actually
connected to Amazon ECS. Registered instances with an agent that may be
unhealthy or stopped return false, and instances without a
connected agent cannot accept placement requests.
Integer runningTasksCount
The number of tasks on the container instance that are in the
RUNNING status.
Integer pendingTasksCount
The number of tasks on the container instance that are in the
PENDING status.
String agentUpdateStatus
The status of the most recent agent update. If an update has never been
requested, this value is NULL.
com.amazonaws.internal.SdkInternalList<T> attributes
The attributes set for the container instance by the Amazon ECS container agent at instance registration.
String name
The name of the container that receives the override.
com.amazonaws.internal.SdkInternalList<T> command
The command to send to the container that overrides the default command from the Docker image or the task definition.
com.amazonaws.internal.SdkInternalList<T> environment
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
String clusterName
The name of your cluster. If you do not specify a name for your cluster,
you create a cluster named default. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Cluster cluster
The full description of your new cluster.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
String serviceName
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores 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.
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to run in your service. If a revision is not
specified, the latest ACTIVE revision is used.
com.amazonaws.internal.SdkInternalList<T> loadBalancers
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer per service. After you create a service, the load balancer name, container name, and container port specified in the service definition are immutable.
For Elastic Load Balancing Classic load balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Elastic Load Balancing Application load balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Integer desiredCount
The number of instantiations of the specified task definition to place and keep running on your cluster.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
String role
The name or full Amazon Resource Name (ARN) of the IAM role that allows
Amazon ECS to make calls to your load balancer on your behalf. This
parameter is required if you are using a load balancer with your service.
If you specify the role parameter, you must also specify a
load balancer object with the loadBalancers parameter.
If your specified role has a path other than /, then you
must either specify the full role ARN (this is recommended) or prefix the
role name with the path. For example, if a role with the name
bar has a path of /foo/ then you would specify
/foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
DeploymentConfiguration deploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Service service
The full description of your service following the create call.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster to delete.
Cluster cluster
The full description of the deleted cluster.
Service service
The full description of the deleted service.
String id
The ID of the deployment.
String status
The status of the deployment. Valid values are PRIMARY (for
the most recent deployment), ACTIVE (for previous
deployments that still have tasks running, but are being replaced with
the PRIMARY deployment), and INACTIVE (for
deployments that have been completely replaced).
String taskDefinition
The most recent task definition that was specified for the service to use.
Integer desiredCount
The most recent desired count of tasks that was specified for the service to deploy or maintain.
Integer pendingCount
The number of tasks in the deployment that are in the
PENDING status.
Integer runningCount
The number of tasks in the deployment that are in the
RUNNING status.
Date createdAt
The Unix timestamp for when the service was created.
Date updatedAt
The Unix timestamp for when the service was last updated.
Integer maximumPercent
The upper limit (as a percentage of the service's
desiredCount) of the number of running tasks that can be
running in a service during a deployment. The maximum number of tasks
during a deployment is the desiredCount multiplied by the
maximumPercent/100, rounded down to the nearest integer
value.
Integer minimumHealthyPercent
The lower limit (as a percentage of the service's
desiredCount) of the number of running tasks that must
remain running and healthy in a service during a deployment. The minimum
healthy tasks during a deployment is the desiredCount
multiplied by the minimumHealthyPercent/100, rounded up to
the nearest integer value.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
String containerInstance
The container instance ID or full Amazon Resource Name (ARN) of the
container instance to deregister. 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
.
Boolean force
Forces the deregistration of the container instance. If you have tasks
running on the container instance when you deregister it with the
force option, these tasks remain running and they continue
to pass Elastic Load Balancing load balancer health checks until you
terminate the instance or the tasks stop through some other means, but
they are orphaned (no longer monitored or accounted for by Amazon ECS).
If an orphaned task on your container instance is part of an Amazon ECS
service, then the service scheduler starts another copy of that task, on
a different container instance if possible.
ContainerInstance containerInstance
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to deregister. You must specify a revision.
TaskDefinition taskDefinition
The full description of the deregistered task.
com.amazonaws.internal.SdkInternalList<T> clusters
A space-separated list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> clusters
The list of clusters.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> containerInstances
A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.
com.amazonaws.internal.SdkInternalList<T> containerInstances
The list of container instances.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String cluster
The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> services
A list of services to describe.
com.amazonaws.internal.SdkInternalList<T> services
The list of services described.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String taskDefinition
The family for the latest ACTIVE revision,
family and revision (
family:revision) for a specific revision in the family, or
full Amazon Resource Name (ARN) of the task definition to describe.
TaskDefinition taskDefinition
The full task definition description.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> tasks
A space-separated list of task IDs or full Amazon Resource Name (ARN) entries.
com.amazonaws.internal.SdkInternalList<T> tasks
The list of tasks.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String containerInstance
The container instance ID or full 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
.
String cluster
The cluster that the container instance belongs to.
String sourcePath
The path on the host container instance that is presented to the
container. If this parameter is empty, then the Docker daemon has
assigned a host path for you. If the host parameter contains
a sourcePath file location, then the data volume persists at
the specified location on the host container instance until you delete it
manually. If the sourcePath value does not exist on the host
container instance, the Docker daemon creates it. If the location does
exist, the contents of the source path folder are exported.
String nextToken
The nextToken value returned from a previous paginated
ListClusters request where maxResults was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Integer maxResults
The maximum number of cluster results returned by
ListClusters in paginated output. When this parameter is
used, ListClusters only returns maxResults
results in a single page along with a nextToken response
element. The remaining results of the initial request can be seen by
sending another ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListClusters returns up to
100 results and a nextToken value if applicable.
com.amazonaws.internal.SdkInternalList<T> clusterArns
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
String nextToken
The nextToken value to include in a future
ListClusters request. When the results of a
ListClusters request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed..
String nextToken
The nextToken value returned from a previous paginated
ListContainerInstances request where maxResults
was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Integer maxResults
The maximum number of container instance results returned by
ListContainerInstances in paginated output. When this
parameter is used, ListContainerInstances only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListContainerInstances request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListContainerInstances
returns up to 100 results and a nextToken value if
applicable.
com.amazonaws.internal.SdkInternalList<T> containerInstanceArns
The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.
String nextToken
The nextToken value to include in a future
ListContainerInstances request. When the results of a
ListContainerInstances request exceed
maxResults, this value can be used to retrieve the next page
of results. This value is null when there are no more
results to return.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed..
String nextToken
The nextToken value returned from a previous paginated
ListServices request where maxResults was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Integer maxResults
The maximum number of container instance results returned by
ListServices in paginated output. When this parameter is
used, ListServices only returns maxResults
results in a single page along with a nextToken response
element. The remaining results of the initial request can be seen by
sending another ListServices request with the returned
nextToken value. This value can be between 1 and 10. If this
parameter is not used, then ListServices returns up to 10
results and a nextToken value if applicable.
com.amazonaws.internal.SdkInternalList<T> serviceArns
The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.
String nextToken
The nextToken value to include in a future
ListServices request. When the results of a
ListServices request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.
String familyPrefix
The familyPrefix is a string that is used to filter the
results of ListTaskDefinitionFamilies. If you specify a
familyPrefix, only task definition family names that begin
with the familyPrefix string are returned.
String status
The task definition family status with which to filter the
ListTaskDefinitionFamilies results. By default, both
ACTIVE and INACTIVE task definition families
are listed. If this parameter is set to ACTIVE, only task
definition families that have an ACTIVE task definition
revision are returned. If this parameter is set to INACTIVE,
only task definition families that do not have any ACTIVE
task definition revisions are returned. If you paginate the resulting
output, be sure to keep the status value constant in each
subsequent request.
String nextToken
The nextToken value returned from a previous paginated
ListTaskDefinitionFamilies request where
maxResults was used and the results exceeded the value of
that parameter. Pagination continues from the end of the previous results
that returned the nextToken value. This value is
null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Integer maxResults
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies in paginated output. When this
parameter is used, ListTaskDefinitions only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListTaskDefinitionFamilies request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListTaskDefinitionFamilies
returns up to 100 results and a nextToken value if
applicable.
com.amazonaws.internal.SdkInternalList<T> families
The list of task definition family names that match the
ListTaskDefinitionFamilies request.
String nextToken
The nextToken value to include in a future
ListTaskDefinitionFamilies request. When the results of a
ListTaskDefinitionFamilies request exceed
maxResults, this value can be used to retrieve the next page
of results. This value is null when there are no more
results to return.
String familyPrefix
The full family name with which to filter the
ListTaskDefinitions results. Specifying a
familyPrefix limits the listed task definitions to task
definition revisions that belong to that family.
String status
The task definition status with which to filter the
ListTaskDefinitions results. By default, only
ACTIVE task definitions are listed. By setting this
parameter to INACTIVE, you can view task definitions that
are INACTIVE as long as an active task or service still
references them. If you paginate the resulting output, be sure to keep
the status value constant in each subsequent request.
String sort
The order in which to sort the results. Valid values are ASC
and DESC. By default (ASC), task definitions
are listed lexicographically by family name and in ascending numerical
order by revision so that the newest task definitions in a family are
listed last. Setting this parameter to DESC reverses the
sort order on family name and revision so that the newest task
definitions in a family are listed first.
String nextToken
The nextToken value returned from a previous paginated
ListTaskDefinitions request where maxResults
was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Integer maxResults
The maximum number of task definition results returned by
ListTaskDefinitions in paginated output. When this parameter
is used, ListTaskDefinitions only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListTaskDefinitions request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListTaskDefinitions returns
up to 100 results and a nextToken value if applicable.
com.amazonaws.internal.SdkInternalList<T> taskDefinitionArns
The list of task definition Amazon Resource Name (ARN) entries for the
ListTaskDefinitions request.
String nextToken
The nextToken value to include in a future
ListTaskDefinitions request. When the results of a
ListTaskDefinitions request exceed maxResults,
this value can be used to retrieve the next page of results. This value
is null when there are no more results to return.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed..
String containerInstance
The container instance ID or full Amazon Resource Name (ARN) of the
container instance with which to filter the ListTasks
results. Specifying a containerInstance limits the results
to tasks that belong to that container instance.
String family
The name of the family with which to filter the ListTasks
results. Specifying a family limits the results to tasks
that belong to that family.
String nextToken
The nextToken value returned from a previous paginated
ListTasks request where maxResults was used and
the results exceeded the value of that parameter. Pagination continues
from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Integer maxResults
The maximum number of task results returned by ListTasks in
paginated output. When this parameter is used, ListTasks
only returns maxResults results in a single page along with
a nextToken response element. The remaining results of the
initial request can be seen by sending another ListTasks
request with the returned nextToken value. This value can be
between 1 and 100. If this parameter is not used, then
ListTasks returns up to 100 results and a
nextToken value if applicable.
String startedBy
The startedBy value with which to filter the task results.
Specifying a startedBy value limits the results to tasks
that were started with that value.
String serviceName
The name of the service with which to filter the ListTasks
results. Specifying a serviceName limits the results to
tasks that belong to that service.
String desiredStatus
The task desired status with which to filter the ListTasks
results. Specifying a desiredStatus of STOPPED
limits the results to tasks that ECS has set the desired status to
STOPPED, which can be useful for debugging tasks that are
not starting properly or have died or finished. The default status filter
is RUNNING, which shows tasks that ECS has set the desired
status to RUNNING.
Although you can filter results based on a desired status of
PENDING, this will not return any results because ECS never
sets the desired status of a task to that value (only a task's
lastStatus may have a value of PENDING).
com.amazonaws.internal.SdkInternalList<T> taskArns
The list of task Amazon Resource Name (ARN) entries for the
ListTasks request.
String nextToken
The nextToken value to include in a future
ListTasks request. When the results of a
ListTasks request exceed maxResults, this value
can be used to retrieve the next page of results. This value is
null when there are no more results to return.
String targetGroupArn
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
String loadBalancerName
The name of the load balancer.
String containerName
The name of the container (as it appears in a container definition) to associate with the load balancer.
Integer containerPort
The port on the container to associate with the load balancer. This port
must correspond to a containerPort in the service's task
definition. Your container instances must allow ingress traffic on the
hostPort of the port mapping.
String logDriver
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
Map<K,V> options
The configuration options to send to the log driver. This parameter
requires version 1.19 of the Docker Remote API or greater on your
container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
String sourceVolume
The name of the volume to mount.
String containerPath
The path on the container to mount the host volume at.
Boolean readOnly
If this value is true, the container has read-only access to
the volume. If this value is false, then the container can
write to the volume. The default value is false.
String bindIP
The IP address that the container is bound to on the container instance.
Integer containerPort
The port number on the container that is be used with the network binding.
Integer hostPort
The port number on the host that is used with the network binding.
String protocol
The protocol used for the network binding.
Integer containerPort
The port number on the container that is bound to the user-specified or
automatically assigned host port. If you specify a container port and not
a host port, your container automatically receives a host port in the
ephemeral port range (for more information, see hostPort).
Port mappings that are automatically assigned in this way do not count
toward the 100 reserved ports limit of a container instance.
Integer hostPort
The port number on the container instance to reserve for your container.
You can specify a non-reserved host port for your container port mapping,
or you can omit the hostPort (or set it to 0)
while specifying a containerPort and your container
automatically receives a port in the ephemeral port range for your
container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is
used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and
later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range; if this kernel
parameter is unavailable, the default ephemeral port range is used. You
should not attempt to specify a host port in the ephemeral port range,
because these are reserved for automatic assignment. In general, ports
below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and
2376, and the Amazon ECS container agent port 51678. Any host port that
was previously specified in a running task is also reserved while the
task is running (after a task stops, the host port is released).The
current reserved ports are displayed in the
remainingResources of DescribeContainerInstances
output, and a container instance may have up to 100 reserved ports at a
time, including the default reserved ports (automatically assigned ports
do not count toward the 100 reserved ports limit).
String protocol
The protocol used for the port mapping. Valid values are tcp
and udp. The default is tcp.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed..
String instanceIdentityDocument
The instance identity document for the EC2 instance to register. This
document can be found by running the following command from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/document/
String instanceIdentityDocumentSignature
The instance identity document signature for the EC2 instance to
register. This signature can be found by running the following command
from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
com.amazonaws.internal.SdkInternalList<T> totalResources
The resources available on the instance.
VersionInfo versionInfo
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
String containerInstanceArn
The Amazon Resource Name (ARN) of the container instance (if it was previously registered).
com.amazonaws.internal.SdkInternalList<T> attributes
The container instance attributes that this container instance supports.
ContainerInstance containerInstance
String family
You must specify a family for a task definition, which
allows you to track multiple versions of the same task definition. The
family is used as a name for your task definition. Up to 255
letters (uppercase and lowercase), numbers, hyphens, and underscores are
allowed.
String taskRoleArn
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
String networkMode
The Docker networking mode to use for the containers in the task. The
valid values are none, bridge, and
host.
The default Docker network mode is bridge. If the network
mode is set to none, you cannot specify port mappings in
your container definitions, and the task's containers do not have
external connectivity. The host network mode offers the
highest networking performance for containers because they use the host
network stack instead of the virtualized network stack provided by the
bridge mode; however, exposed container ports are mapped
directly to the corresponding host port, so you cannot take advantage of
dynamic host port mappings or run multiple instantiations of the same
task on a single container instance if port mappings are used.
For more information, see Network settings in the Docker run reference.
com.amazonaws.internal.SdkInternalList<T> containerDefinitions
A list of container definitions in JSON format that describe the different containers that make up your task.
com.amazonaws.internal.SdkInternalList<T> volumes
A list of volume definitions in JSON format that containers in your task may use.
TaskDefinition taskDefinition
The full description of the registered task definition.
String name
The name of the resource, such as CPU, MEMORY,
PORTS, or a user-defined resource.
String type
The type of the resource, such as INTEGER,
DOUBLE, LONG, or STRINGSET.
Double doubleValue
When the doubleValue type is set, the value of the resource
must be a double precision floating-point type.
Long longValue
When the longValue type is set, the value of the resource
must be an extended precision floating-point type.
Integer integerValue
When the integerValue type is set, the value of the resource
must be an integer.
com.amazonaws.internal.SdkInternalList<T> stringSetValue
When the stringSetValue type is set, the value of the
resource must be a string type.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed..
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to run. If a revision is not specified, the
latest ACTIVE revision is used.
TaskOverride overrides
A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should
receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a
command override. You can also override existing environment
variables (that are specified in the task definition or Docker image) on
a container or add new environment variables to it with an
environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
Integer count
The number of instantiations of the specified task to place on your cluster.
The count parameter is limited to 10 tasks per call.
String startedBy
An optional tag specified when a task is started. For example if you
automatically trigger a task to run a batch process job, you could apply
a unique identifier for that job to your task with the
startedBy parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy value. Up to 36 letters (uppercase and
lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the
startedBy parameter contains the deployment ID of the
service that starts it.
com.amazonaws.internal.SdkInternalList<T> tasks
A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String serviceArn
The Amazon Resource Name (ARN) that identifies the service. The ARN
contains the arn:aws:ecs namespace, followed by the region
of the service, the AWS account ID of the service owner, the
service namespace, and then the service name. For example,
arn:aws:ecs:region:012345678910:service/my-service
.
String serviceName
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores 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.
String clusterArn
The Amazon Resource Name (ARN) of the cluster that hosts the service.
com.amazonaws.internal.SdkInternalList<T> loadBalancers
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
String status
The status of the service. The valid values are ACTIVE,
DRAINING, or INACTIVE.
Integer desiredCount
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.
Integer runningCount
The number of tasks in the cluster that are in the RUNNING
state.
Integer pendingCount
The number of tasks in the cluster that are in the PENDING
state.
String taskDefinition
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.
DeploymentConfiguration deploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
com.amazonaws.internal.SdkInternalList<T> deployments
The current state of deployments for the service.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
com.amazonaws.internal.SdkInternalList<T> events
The event stream for your service. A maximum of 100 of the latest events are displayed.
Date createdAt
The Unix timestamp for when the service was created.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to start. If a revision is not specified,
the latest ACTIVE revision is used.
TaskOverride overrides
A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should
receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a
command override. You can also override existing environment
variables (that are specified in the task definition or Docker image) on
a container or add new environment variables to it with an
environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
com.amazonaws.internal.SdkInternalList<T> containerInstances
The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
The list of container instances to start tasks on is limited to 10.
String startedBy
An optional tag specified when a task is started. For example if you
automatically trigger a task to run a batch process job, you could apply
a unique identifier for that job to your task with the
startedBy parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy value. Up to 36 letters (uppercase and
lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the
startedBy parameter contains the deployment ID of the
service that starts it.
com.amazonaws.internal.SdkInternalList<T> tasks
A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed..
String task
The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
String reason
An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
Task task
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.
String task
The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
String containerName
The name of the container.
String status
The status of the state change request.
Integer exitCode
The exit code returned for the state change request.
String reason
The reason for the state change request.
com.amazonaws.internal.SdkInternalList<T> networkBindings
The network bindings of the container.
String acknowledgment
Acknowledgement of the state change.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
String task
The task ID or full Amazon Resource Name (ARN) of the task in the state change request.
String status
The status of the state change request.
String reason
The reason for the state change request.
String acknowledgment
Acknowledgement of the state change.
String taskArn
The Amazon Resource Name (ARN) of the task.
String clusterArn
The Amazon Resource Name (ARN) of the cluster that hosts the task.
String taskDefinitionArn
The Amazon Resource Name (ARN) of the task definition that creates the task.
String containerInstanceArn
The Amazon Resource Name (ARN) of the container instances that host the task.
TaskOverride overrides
One or more container overrides.
String lastStatus
The last known status of the task.
String desiredStatus
The desired status of the task.
com.amazonaws.internal.SdkInternalList<T> containers
The containers associated with the task.
String startedBy
The tag specified when a task is started. If the task is started by an
Amazon ECS service, then the startedBy parameter contains
the deployment ID of the service that starts it.
String stoppedReason
The reason the task was stopped.
Date createdAt
The Unix timestamp for when the task was created (the task entered the
PENDING state).
Date startedAt
The Unix timestamp for when the task was started (the task transitioned
from the PENDING state to the RUNNING state).
Date stoppedAt
The Unix timestamp for when the task was stopped (the task transitioned
from the RUNNING state to the STOPPED state).
String taskDefinitionArn
The full Amazon Resource Name (ARN) of the task definition.
com.amazonaws.internal.SdkInternalList<T> containerDefinitions
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
String family
The family of your task definition, used as the definition name.
String taskRoleArn
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
String networkMode
The Docker networking mode to use for the containers in the task. The
valid values are none, bridge, and
host.
If the network mode is none, the containers do not have
external connectivity. The default Docker network mode is
bridge. The host network mode offers the
highest networking performance for containers because it uses the host
network stack instead of the virtualized network stack provided by the
bridge mode.
For more information, see Network settings in the Docker run reference.
Integer revision
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a task
definition for the first time, the revision is 1; each time
you register a new revision of a task definition in the same family, the
revision value always increases by one (even if you have deregistered
previous revisions in this family).
com.amazonaws.internal.SdkInternalList<T> volumes
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
String status
The status of the task definition.
com.amazonaws.internal.SdkInternalList<T> requiresAttributes
The container instance attributes required by your task.
com.amazonaws.internal.SdkInternalList<T> containerOverrides
One or more container overrides sent to a task.
String taskRoleArn
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
String containerInstance
The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.
ContainerInstance containerInstance
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
String service
The name of the service to update.
Integer desiredCount
The number of instantiations of the task to place and keep running in your service.
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to run in your service. If a revision is not
specified, the latest ACTIVE revision is used. If you modify
the task definition with UpdateService, Amazon ECS spawns a
task with the new version of the task definition and then stops an old
task after the new version is running.
DeploymentConfiguration deploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Service service
The full description of your service following the update call.
String agentVersion
The version number of the Amazon ECS container agent.
String agentHash
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs- agent GitHub repository.
String dockerVersion
The Docker version running on the container instance.
String name
The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, and underscores are allowed. This name is referenced in
the sourceVolume parameter of container definition
mountPoints.
HostVolumeProperties host
The contents of the host parameter determine whether your
data volume persists on the host container instance and where it is
stored. If the host parameter is empty, then the Docker daemon assigns a
host path for your data volume, but the data is not guaranteed to persist
after the containers associated with it stop running.
Copyright © 2016. All rights reserved.