String clusterArn
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
String status
ACTIVE
or
INACTIVE
. ACTIVE
indicates that you can
register container instances with the cluster and the associated
instances can accept tasks.Integer registeredContainerInstancesCount
Integer runningTasksCount
RUNNING
state.Integer pendingTasksCount
PENDING
state.Integer activeServicesCount
ACTIVE
state. You can view these services with
ListServices.String containerArn
String taskArn
String name
String lastStatus
Integer exitCode
String reason
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkBindings
String name
name
of one container
can be entered in the links
of another container to
connect the containers.String image
repository-url/image:tag
.Integer cpu
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. 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 will allow 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:
Integer memory
com.amazonaws.internal.ListWithAutoConstructFlag<T> links
link
parameter allows containers to communicate with
each other without the need for port mappings, using the
name
parameter. The name:internalName
construct is analogous to name:alias
in Docker links. For
more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
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.ListWithAutoConstructFlag<T> portMappings
Boolean essential
essential
parameter of a container is marked as
true
, the failure of that container will stop the task.
If the essential
parameter of a container is marked as
false
, then its failure will 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.
com.amazonaws.internal.ListWithAutoConstructFlag<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 ENTRYPOINT
that is passed to
the container. For more information on the Docker
ENTRYPOINT
parameter, see https://docs.docker.com/reference/builder/#entrypoint.
com.amazonaws.internal.ListWithAutoConstructFlag<T> command
CMD
that is passed to the container. For more
information on the Docker CMD
parameter, see https://docs.docker.com/reference/builder/#cmd.com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
com.amazonaws.internal.ListWithAutoConstructFlag<T> mountPoints
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumesFrom
String containerInstanceArn
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 UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.String ec2InstanceId
VersionInfo versionInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> remainingResources
com.amazonaws.internal.ListWithAutoConstructFlag<T> registeredResources
String status
ACTIVE
or INACTIVE
. ACTIVE
indicates that the container instance can accept tasks.Boolean agentConnected
true
if the agent is actually
connected to Amazon ECS. Registered instances with an agent that may
be unhealthy or stopped will return false
, and instances
without a connected agent cannot accept placement request.Integer runningTasksCount
RUNNING
status.Integer pendingTasksCount
PENDING
status.String agentUpdateStatus
NULL
.
Constraints:
Allowed Values: PENDING, STAGING, STAGED, UPDATING, UPDATED, FAILED
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> command
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
String clusterName
default
. Up to
255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed.Cluster cluster
String cluster
String serviceName
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to run in your service. If a
revision
is not specified, the latest ACTIVE
revision is used.com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
Integer desiredCount
String clientToken
String role
Service service
String cluster
Cluster cluster
Service service
String id
String status
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
Integer desiredCount
Integer pendingCount
PENDING
status.Integer runningCount
RUNNING
status.Date createdAt
Date updatedAt
String cluster
String containerInstance
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 UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.Boolean force
force
parameter if you have several tasks running on a
container instance and you don't want to run StopTask
for
each task before deregistering the container instance.ContainerInstance containerInstance
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to deregister. You must specify a
revision
.TaskDefinition taskDefinition
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> services
com.amazonaws.internal.ListWithAutoConstructFlag<T> services
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String taskDefinition
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 that you
want to describe.TaskDefinition taskDefinition
String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String containerInstance
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 UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.String cluster
String sourcePath
String nextToken
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.Integer maxResults
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.ListWithAutoConstructFlag<T> clusterArns
String nextToken
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
String nextToken
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.Integer maxResults
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.ListWithAutoConstructFlag<T> containerInstanceArns
String nextToken
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
String nextToken
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.Integer maxResults
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 100. If
this parameter is not used, then ListServices
returns up
to 100 results and a nextToken
value if applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceArns
String nextToken
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
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 nextToken
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.Integer maxResults
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.ListWithAutoConstructFlag<T> families
ListTaskDefinitionFamilies
request.String nextToken
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
ListTaskDefinitions
results with. Specifying a
familyPrefix
will limit the listed task definitions to
task definition revisions that belong to that family.String status
ListTaskDefinitions
results with. 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.
Constraints:
Allowed Values: ACTIVE, INACTIVE
String sort
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.
Constraints:
Allowed Values: ASC, DESC
String nextToken
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.Integer maxResults
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.ListWithAutoConstructFlag<T> taskDefinitionArns
ListTaskDefintions
request.String nextToken
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
String containerInstance
ListTasks
results with. Specifying a containerInstance
will limit
the results to tasks that belong to that container instance.String family
ListTasks
results with. Specifying a family
will limit the results to tasks that belong to that family.String nextToken
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.Integer maxResults
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
startedBy
value that you want to filter the task
results with. Specifying a startedBy
value will limit the
results to tasks that were started with that value.String serviceName
ListTasks
results with. Specifying a
serviceName
will limit the results to tasks that belong
to that service.String desiredStatus
ListTasks
results with. Specifying a desiredStatus
of
STOPPED
will limit the results to tasks that are in the
STOPPED
status, which can be useful for debugging tasks
that are not starting properly or have died or finished. The default
status filter is RUNNING
.
Constraints:
Allowed Values: RUNNING, PENDING, STOPPED
com.amazonaws.internal.ListWithAutoConstructFlag<T> taskArns
ListTasks
request.String nextToken
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 loadBalancerName
String containerName
Integer containerPort
containerPort
in the service's
task definition. Your container instances must allow ingress traffic
on the hostPort
of the port mapping.String sourceVolume
String containerPath
Boolean readOnly
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
Integer containerPort
Integer hostPort
String protocol
Constraints:
Allowed Values: tcp, udp
Integer containerPort
hostPort
).Integer hostPort
hostPort
(or set it to
0
) while specifying a containerPort
and your
container will automatically receive 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, since 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 (once 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 50 reserved ports at a
time, including the default reserved ports (automatically assigned
ports do not count toward this limit).
String protocol
tcp
and udp
. The default is
tcp
.
Constraints:
Allowed Values: tcp, udp
String cluster
String instanceIdentityDocument
curl
http://169.254.169.254/latest/dynamic/instance-identity/document/
String instanceIdentityDocumentSignature
curl
http://169.254.169.254/latest/dynamic/instance-identity/signature/
com.amazonaws.internal.ListWithAutoConstructFlag<T> totalResources
VersionInfo versionInfo
ContainerInstance containerInstance
String family
family
for a task definition, which
allows you to track multiple versions of the same task definition. You
can think of the family
as a name for your task
definition. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed.com.amazonaws.internal.ListWithAutoConstructFlag<T> containerDefinitions
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
TaskDefinition taskDefinition
String name
CPU
,
MEMORY
, PORTS
, or a user-defined resource.String type
INTEGER
,
DOUBLE
, LONG
, or STRINGSET
.Double doubleValue
doubleValue
type is set, the value of the
resource must be a double precision floating-point type.Long longValue
longValue
type is set, the value of the resource
must be an extended precision floating-point type.Integer integerValue
integerValue
type is set, the value of the
resource must be an integer.com.amazonaws.internal.ListWithAutoConstructFlag<T> stringSetValue
stringSetValue
type is set, the value of the
resource must be a string type.String cluster
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to run. If a revision
is not specified, the latest ACTIVE
revision is used.TaskOverride overrides
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 count
parameter is limited to 10 tasks per call.
String startedBy
startedBy
parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy
value. 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.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
RunTask
action are listed
here.String serviceArn
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
String clusterArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
String status
ACTIVE
,
DRAINING
, or INACTIVE
.Integer desiredCount
Integer runningCount
RUNNING
state.Integer pendingCount
PENDING
state.String taskDefinition
com.amazonaws.internal.ListWithAutoConstructFlag<T> deployments
String roleArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String cluster
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to start. If a revision
is not specified, the latest ACTIVE
revision is used.TaskOverride overrides
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.ListWithAutoConstructFlag<T> containerInstances
The list of container instances to start tasks on is limited to 10.
String startedBy
startedBy
parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy
value. 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.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
StartTask
action are listed
here.String cluster
String task
Task task
String cluster
String task
String containerName
String status
Integer exitCode
String reason
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkBindings
String acknowledgment
String cluster
String task
String status
String reason
String acknowledgment
String taskArn
String clusterArn
String taskDefinitionArn
String containerInstanceArn
TaskOverride overrides
String lastStatus
String desiredStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> containers
String startedBy
startedBy
parameter contains
the deployment ID of the service that starts it.String taskDefinitionArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerDefinitions
String family
family
as the name of your task definition.Integer revision
1
, and 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.ListWithAutoConstructFlag<T> volumes
String status
Constraints:
Allowed Values: ACTIVE, INACTIVE
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerOverrides
String cluster
String containerInstance
ContainerInstance containerInstance
String cluster
String service
Integer desiredCount
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want 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.Service service
String agentVersion
String agentHash
String dockerVersion
String name
sourceVolume
parameter of container definition
mountPoints
.HostVolumeProperties host
Copyright © 2015. All rights reserved.