Class: AWS.ECS
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.ECS
- Identifier:
- ecs
- API Version:
- 2014-11-13
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.
Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.
Sending a Request Using ECS
var ecs = new AWS.ECS();
ecs.createCapacityProvider(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the ECS object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var ecs = new AWS.ECS({apiVersion: '2014-11-13'});
You can also set the API version globally in AWS.config.apiVersions
using
the ecs service identifier:
AWS.config.apiVersions = {
ecs: '2014-11-13',
// other service API versions
};
var ecs = new AWS.ECS();
Version:
-
2014-11-13
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
tasksRunning, tasksStopped, servicesStable, servicesInactive
Constructor Summary collapse
-
new AWS.ECS(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createCapacityProvider(params = {}, callback) ⇒ AWS.Request
Creates a new capacity provider.
-
createCluster(params = {}, callback) ⇒ AWS.Request
Creates a new Amazon ECS cluster.
-
createService(params = {}, callback) ⇒ AWS.Request
Runs and maintains your desired number of tasks from a specified task definition.
-
createTaskSet(params = {}, callback) ⇒ AWS.Request
Create a task set in the specified cluster and service.
-
deleteAccountSetting(params = {}, callback) ⇒ AWS.Request
Disables an account setting for a specified user, role, or the root user for an account.
.
-
deleteAttributes(params = {}, callback) ⇒ AWS.Request
Deletes one or more custom attributes from an Amazon ECS resource.
.
-
deleteCapacityProvider(params = {}, callback) ⇒ AWS.Request
Deletes the specified capacity provider.
Note: TheFARGATE
andFARGATE_SPOT
capacity providers are reserved and can't be deleted.- deleteCluster(params = {}, callback) ⇒ AWS.Request
Deletes the specified cluster.
- deleteService(params = {}, callback) ⇒ AWS.Request
Deletes a specified service within a cluster.
- deleteTaskDefinitions(params = {}, callback) ⇒ AWS.Request
Deletes one or more task definitions.
You must deregister a task definition revision before you delete it.
- deleteTaskSet(params = {}, callback) ⇒ AWS.Request
Deletes a specified task set within a service.
- deregisterContainerInstance(params = {}, callback) ⇒ AWS.Request
Deregisters an Amazon ECS container instance from the specified cluster.
- deregisterTaskDefinition(params = {}, callback) ⇒ AWS.Request
Deregisters the specified task definition by family and revision.
- describeCapacityProviders(params = {}, callback) ⇒ AWS.Request
Describes one or more of your capacity providers.
.
- describeClusters(params = {}, callback) ⇒ AWS.Request
Describes one or more of your clusters.
.
- describeContainerInstances(params = {}, callback) ⇒ AWS.Request
Describes one or more container instances.
- describeServices(params = {}, callback) ⇒ AWS.Request
Describes the specified services running in your cluster.
.
- describeTaskDefinition(params = {}, callback) ⇒ AWS.Request
Describes a task definition.
- describeTasks(params = {}, callback) ⇒ AWS.Request
Describes a specified task or tasks.
Currently, stopped tasks appear in the returned results for at least one hour.
If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response.
- describeTaskSets(params = {}, callback) ⇒ AWS.Request
Describes the task sets in the specified cluster and service.
- discoverPollEndpoint(params = {}, callback) ⇒ AWS.Request
Note: This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.- executeCommand(params = {}, callback) ⇒ AWS.Request
Runs a command remotely on a container within a task.
If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an
AccessDeniedException
when there is a mismatch between the condition key value and the corresponding parameter value.For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.
- getTaskProtection(params = {}, callback) ⇒ AWS.Request
Retrieves the protection status of tasks in an Amazon ECS service.
.
- listAccountSettings(params = {}, callback) ⇒ AWS.Request
Lists the account settings for a specified principal.
.
- listAttributes(params = {}, callback) ⇒ AWS.Request
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
- listClusters(params = {}, callback) ⇒ AWS.Request
Returns a list of existing clusters.
.
- listContainerInstances(params = {}, callback) ⇒ AWS.Request
Returns a list of container instances in a specified cluster.
- listServices(params = {}, callback) ⇒ AWS.Request
Returns a list of services.
- listServicesByNamespace(params = {}, callback) ⇒ AWS.Request
This operation lists all of the services that are associated with a Cloud Map namespace.
- listTagsForResource(params = {}, callback) ⇒ AWS.Request
List the tags for an Amazon ECS resource.
.
- listTaskDefinitionFamilies(params = {}, callback) ⇒ AWS.Request
Returns a list of task definition families that are registered to your account.
- listTaskDefinitions(params = {}, callback) ⇒ AWS.Request
Returns a list of task definitions that are registered to your account.
- listTasks(params = {}, callback) ⇒ AWS.Request
Returns a list of tasks.
- putAccountSetting(params = {}, callback) ⇒ AWS.Request
Modifies an account setting.
- putAccountSettingDefault(params = {}, callback) ⇒ AWS.Request
Modifies an account setting for all users on an account for whom no individual account setting has been specified.
- putAttributes(params = {}, callback) ⇒ AWS.Request
Create or update an attribute on an Amazon ECS resource.
- putClusterCapacityProviders(params = {}, callback) ⇒ AWS.Request
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster.
- registerContainerInstance(params = {}, callback) ⇒ AWS.Request
Note: This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.- registerTaskDefinition(params = {}, callback) ⇒ AWS.Request
Registers a new task definition from the supplied
family
andcontainerDefinitions
.- runTask(params = {}, callback) ⇒ AWS.Request
Starts a new task using the specified task definition.
Note: On March 21, 2024, a change was made to resolve the task definition revision before authorization.- startTask(params = {}, callback) ⇒ AWS.Request
Starts a new task from the specified task definition on the specified container instance or instances.
Note: On March 21, 2024, a change was made to resolve the task definition revision before authorization.- stopTask(params = {}, callback) ⇒ AWS.Request
Stops a running task.
- submitAttachmentStateChanges(params = {}, callback) ⇒ AWS.Request
Note: This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.- submitContainerStateChange(params = {}, callback) ⇒ AWS.Request
Note: This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.- submitTaskStateChange(params = {}, callback) ⇒ AWS.Request
Note: This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.- tagResource(params = {}, callback) ⇒ AWS.Request
Associates the specified tags to a resource with the specified
resourceArn
.- untagResource(params = {}, callback) ⇒ AWS.Request
Deletes specified tags from a resource.
.
- updateCapacityProvider(params = {}, callback) ⇒ AWS.Request
Modifies the parameters for a capacity provider.
.
- updateCluster(params = {}, callback) ⇒ AWS.Request
Updates the cluster.
.
- updateClusterSettings(params = {}, callback) ⇒ AWS.Request
Modifies the settings to use for a cluster.
.
- updateContainerAgent(params = {}, callback) ⇒ AWS.Request
Updates the Amazon ECS container agent on a specified container instance.
- updateContainerInstancesState(params = {}, callback) ⇒ AWS.Request
Modifies the status of an Amazon ECS container instance.
Once a container instance has reached an
ACTIVE
state, you can change the status of a container instance toDRAINING
to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.A container instance can't be changed to
DRAINING
until it has reached anACTIVE
status.- updateService(params = {}, callback) ⇒ AWS.Request
Modifies the parameters of a service.
Note: On March 21, 2024, a change was made to resolve the task definition revision before authorization.- updateServicePrimaryTaskSet(params = {}, callback) ⇒ AWS.Request
Modifies which task set in a service is the primary task set.
- updateTaskProtection(params = {}, callback) ⇒ AWS.Request
Updates the protection status of a task.
- updateTaskSet(params = {}, callback) ⇒ AWS.Request
Modifies a task set.
- waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given ECS resource.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService
Constructor Details
new AWS.ECS(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a ECS object
var ecs = new AWS.ECS({apiVersion: '2014-11-13'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.ECS.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.ECS.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.ECS.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
createCapacityProvider(params = {}, callback) ⇒ AWS.Request
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the
FARGATE
andFARGATE_SPOT
capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.Service Reference:
Examples:
Calling the createCapacityProvider operation
var params = { autoScalingGroupProvider: { /* required */ autoScalingGroupArn: 'STRING_VALUE', /* required */ managedDraining: ENABLED | DISABLED, managedScaling: { instanceWarmupPeriod: 'NUMBER_VALUE', maximumScalingStepSize: 'NUMBER_VALUE', minimumScalingStepSize: 'NUMBER_VALUE', status: ENABLED | DISABLED, targetCapacity: 'NUMBER_VALUE' }, managedTerminationProtection: ENABLED | DISABLED }, name: 'STRING_VALUE', /* required */ tags: [ { key: 'STRING_VALUE', value: 'STRING_VALUE' }, /* more items */ ] }; ecs.createCapacityProvider(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
name
— (String
)The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "
aws
", "ecs
", or "fargate
".autoScalingGroupProvider
— (map
)The details of the Auto Scaling group for the capacity provider.
autoScalingGroupArn
— required — (String
)The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
managedScaling
— (map
)The managed scaling settings for the Auto Scaling group capacity provider.
status
— (String
)Determines whether to use managed scaling for the capacity provider.
Possible values include:"ENABLED"
"DISABLED"
targetCapacity
— (Integer
)The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than
0
and less than or equal to100
. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use atargetCapacity
of90
. The default value of100
percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.minimumScalingStepSize
— (Integer
)The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of
1
is used.When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
maximumScalingStepSize
— (Integer
)The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of
10000
is used.instanceWarmupPeriod
— (Integer
)The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of
300
seconds is used.
managedTerminationProtection
— (String
)The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
Possible values include:"ENABLED"
"DISABLED"
managedDraining
— (String
)The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
Possible values include:"ENABLED"
"DISABLED"
tags
— (Array<map>
)The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:capacityProvider
— (map
)The full description of the new capacity provider.
capacityProviderArn
— (String
)The Amazon Resource Name (ARN) that identifies the capacity provider.
name
— (String
)The name of the capacity provider.
status
— (String
)The current status of the capacity provider. Only capacity providers in an
Possible values include:ACTIVE
state can be used in a cluster. When a capacity provider is successfully deleted, it has anINACTIVE
status."ACTIVE"
"INACTIVE"
autoScalingGroupProvider
— (map
)The Auto Scaling group settings for the capacity provider.
autoScalingGroupArn
— required — (String
)The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
managedScaling
— (map
)The managed scaling settings for the Auto Scaling group capacity provider.
status
— (String
)Determines whether to use managed scaling for the capacity provider.
Possible values include:"ENABLED"
"DISABLED"
targetCapacity
— (Integer
)The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than
0
and less than or equal to100
. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use atargetCapacity
of90
. The default value of100
percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.minimumScalingStepSize
— (Integer
)The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of
1
is used.When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
maximumScalingStepSize
— (Integer
)The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of
10000
is used.instanceWarmupPeriod
— (Integer
)The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of
300
seconds is used.
managedTerminationProtection
— (String
)The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
Possible values include:"ENABLED"
"DISABLED"
managedDraining
— (String
)The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
Possible values include:"ENABLED"
"DISABLED"
updateStatus
— (String
)The update status of the capacity provider. The following are the possible states that is returned.
- DELETE_IN_PROGRESS
-
The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
-
The capacity provider was successfully deleted and has an
INACTIVE
status. - DELETE_FAILED
-
The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
"DELETE_IN_PROGRESS"
"DELETE_COMPLETE"
"DELETE_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_COMPLETE"
"UPDATE_FAILED"
updateStatusReason
— (String
)The update status reason. This provides further details about the update status for the capacity provider.
tags
— (Array<map>
)The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
-
(AWS.Response)
—
Returns:
createCluster(params = {}, callback) ⇒ AWS.Request
Creates a new Amazon ECS cluster. By default, your account receives a
default
cluster when you launch your first container instance. However, you can create your own cluster with a unique name.Note: When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.Service Reference:
Examples:
To create a new cluster
/* This example creates a cluster in your default region. */ var params = { clusterName: "my_cluster" }; ecs.createCluster(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { cluster: { activeServicesCount: 0, clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", clusterName: "my_cluster", pendingTasksCount: 0, registeredContainerInstancesCount: 0, runningTasksCount: 0, status: "ACTIVE" } } */ });
Calling the createCluster operation
var params = { capacityProviders: [ 'STRING_VALUE', /* more items */ ], clusterName: 'STRING_VALUE', configuration: { executeCommandConfiguration: { kmsKeyId: 'STRING_VALUE', logConfiguration: { cloudWatchEncryptionEnabled: true || false, cloudWatchLogGroupName: 'STRING_VALUE', s3BucketName: 'STRING_VALUE', s3EncryptionEnabled: true || false, s3KeyPrefix: 'STRING_VALUE' }, logging: NONE | DEFAULT | OVERRIDE }, managedStorageConfiguration: { fargateEphemeralStorageKmsKeyId: 'STRING_VALUE', kmsKeyId: 'STRING_VALUE' } }, defaultCapacityProviderStrategy: [ { capacityProvider: 'STRING_VALUE', /* required */ base: 'NUMBER_VALUE', weight: 'NUMBER_VALUE' }, /* more items */ ], serviceConnectDefaults: { namespace: 'STRING_VALUE' /* required */ }, settings: [ { name: containerInsights, value: 'STRING_VALUE' }, /* more items */ ], tags: [ { key: 'STRING_VALUE', value: 'STRING_VALUE' }, /* more items */ ] }; ecs.createCluster(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
clusterName
— (String
)The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named
default
. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.tags
— (Array<map>
)The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
settings
— (Array<map>
)The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the
containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.name
— (String
)The name of the cluster setting. The value is
Possible values include:containerInsights
."containerInsights"
value
— (String
)The value to set for the cluster setting. The supported values are
enabled
anddisabled
.If you set
name
tocontainerInsights
andvalue
toenabled
, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless thecontainerInsights
account setting is turned on. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
configuration
— (map
)The
execute
command configuration for the cluster.executeCommandConfiguration
— (map
)The details of the execute command configuration.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the data between the local client and the container.
logging
— (String
)The log setting to use for redirecting logs for your execute command results. The following log settings are available.
-
NONE
: The execute command session is not logged. -
DEFAULT
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged. -
OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.
"NONE"
"DEFAULT"
"OVERRIDE"
-
logConfiguration
— (map
)The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE
is specified, alogConfiguration
must be provided.cloudWatchLogGroupName
— (String
)The name of the CloudWatch log group to send logs to.
Note: The CloudWatch log group must already be created.cloudWatchEncryptionEnabled
— (Boolean
)Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
s3BucketName
— (String
)The name of the S3 bucket to send logs to.
Note: The S3 bucket must already be created.s3EncryptionEnabled
— (Boolean
)Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
s3KeyPrefix
— (String
)An optional folder in the S3 bucket to place logs in.
managedStorageConfiguration
— (map
)The details of the managed storage configuration.
kmsKeyId
— (String
)Specify a Key Management Service key ID to encrypt the managed storage.
fargateEphemeralStorageKmsKeyId
— (String
)Specify the Key Management Service key ID for the Fargate ephemeral storage.
capacityProviders
— (Array<String>
)The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
defaultCapacityProviderStrategy
— (Array<map>
)The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
serviceConnectDefaults
— (map
)Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the
enabled
parameter totrue
in theServiceConnectConfiguration
. You can set the namespace of each service individually in theServiceConnectConfiguration
to override this default parameter.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
namespace
— required — (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).
If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.
If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.
If you update the cluster with an empty string
""
for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:cluster
— (map
)The full description of your new cluster.
clusterArn
— (String
)The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
clusterName
— (String
)A user-generated string that you use to identify your cluster.
configuration
— (map
)The execute command configuration for the cluster.
executeCommandConfiguration
— (map
)The details of the execute command configuration.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the data between the local client and the container.
logging
— (String
)The log setting to use for redirecting logs for your execute command results. The following log settings are available.
-
NONE
: The execute command session is not logged. -
DEFAULT
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged. -
OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.
"NONE"
"DEFAULT"
"OVERRIDE"
-
logConfiguration
— (map
)The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE
is specified, alogConfiguration
must be provided.cloudWatchLogGroupName
— (String
)The name of the CloudWatch log group to send logs to.
Note: The CloudWatch log group must already be created.cloudWatchEncryptionEnabled
— (Boolean
)Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
s3BucketName
— (String
)The name of the S3 bucket to send logs to.
Note: The S3 bucket must already be created.s3EncryptionEnabled
— (Boolean
)Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
s3KeyPrefix
— (String
)An optional folder in the S3 bucket to place logs in.
managedStorageConfiguration
— (map
)The details of the managed storage configuration.
kmsKeyId
— (String
)Specify a Key Management Service key ID to encrypt the managed storage.
fargateEphemeralStorageKmsKeyId
— (String
)Specify the Key Management Service key ID for the Fargate ephemeral storage.
status
— (String
)The status of the cluster. The following are the possible states that are returned.
- ACTIVE
-
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
-
The cluster has been deleted. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVE
clusters persisting.
registeredContainerInstancesCount
— (Integer
)The number of container instances registered into the cluster. This includes container instances in both
ACTIVE
andDRAINING
status.runningTasksCount
— (Integer
)The number of tasks in the cluster that are in the
RUNNING
state.pendingTasksCount
— (Integer
)The number of tasks in the cluster that are in the
PENDING
state.activeServicesCount
— (Integer
)The number of services that are running on the cluster in an
ACTIVE
state. You can view these services with PListServices.statistics
— (Array<map>
)Additional information about your clusters that are separated by launch type. They include the following:
-
runningEC2TasksCount
-
RunningFargateTasksCount
-
pendingEC2TasksCount
-
pendingFargateTasksCount
-
activeEC2ServiceCount
-
activeFargateServiceCount
-
drainingEC2ServiceCount
-
drainingFargateServiceCount
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
-
tags
— (Array<map>
)The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
settings
— (Array<map>
)The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.
name
— (String
)The name of the cluster setting. The value is
Possible values include:containerInsights
."containerInsights"
value
— (String
)The value to set for the cluster setting. The supported values are
enabled
anddisabled
.If you set
name
tocontainerInsights
andvalue
toenabled
, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless thecontainerInsights
account setting is turned on. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
capacityProviders
— (Array<String>
)The capacity providers associated with the cluster.
defaultCapacityProviderStrategy
— (Array<map>
)The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
attachments
— (Array<map>
)The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
id
— (String
)The unique identifier for the attachment.
type
— (String
)The type of the attachment, such as
ElasticNetworkInterface
,Service Connect
, andAmazonElasticBlockStorage
.status
— (String
)The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
,DELETED
, andFAILED
.details
— (Array<map>
)Details of the attachment.
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
For Service Connect services, this includes
portName
,clientAliases
,discoveryName
, andingressPortOverride
.For Elastic Block Storage, this includes
roleArn
,deleteOnTermination
,volumeName
,volumeId
, andstatusReason
(only when the attachment fails to create or attach).name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
attachmentsStatus
— (String
)The status of the capacity providers associated with the cluster. The following are the states that are returned.
- UPDATE_IN_PROGRESS
-
The available capacity providers for the cluster are updating.
- UPDATE_COMPLETE
-
The capacity providers have successfully updated.
- UPDATE_FAILED
-
The capacity provider updates failed.
serviceConnectDefaults
— (map
)Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the
enabled
parameter totrue
in theServiceConnectConfiguration
. You can set the namespace of each service individually in theServiceConnectConfiguration
to override this default parameter.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
namespace
— (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.
-
(AWS.Response)
—
Returns:
createService(params = {}, callback) ⇒ AWS.Request
Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the
desiredCount
, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.Note: On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service.
volumeConfigurations
is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.Tasks for services that don't use a load balancer are considered healthy if they're in the
RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in theRUNNING
state and are reported as healthy by the load balancer.There are two service scheduler strategies available:
-
REPLICA
- The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide. -
DAEMON
- The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for
minimumHealthyPercent
is 100%. The default value for a daemon service forminimumHealthyPercent
is 0%.If a service uses the
ECS
deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in theRUNNING
state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in theDRAINING
state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in theRUNNING
state, tasks for services that don't use a load balancer are considered healthy . If they're in theRUNNING
state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.If a service uses the
ECS
deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in theRUNNING
orPENDING
state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in theDRAINING
state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.If a service uses either the
CODE_DEPLOY
orEXTERNAL
deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in theRUNNING
state. This is while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.When creating a service that uses the
EXTERNAL
deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Service Reference:
Examples:
To create a new service
/* This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task. */ var params = { desiredCount: 10, serviceName: "ecs-simple-service", taskDefinition: "hello_world" }; ecs.createService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { service: { clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", createdAt: <Date Representation>, deploymentConfiguration: { maximumPercent: 200, minimumHealthyPercent: 100 }, deployments: [ { createdAt: <Date Representation>, desiredCount: 10, id: "ecs-svc/9223370564342348388", pendingCount: 0, runningCount: 0, status: "PRIMARY", taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", updatedAt: <Date Representation> }, { createdAt: <Date Representation>, desiredCount: 0, id: "ecs-svc/9223370564343611322", pendingCount: 0, runningCount: 0, status: "ACTIVE", taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", updatedAt: <Date Representation> } ], desiredCount: 10, events: [ ], loadBalancers: [ ], pendingCount: 0, runningCount: 0, serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", serviceName: "ecs-simple-service", status: "ACTIVE", taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6" } } */ });
To create a new service behind a load balancer
/* This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name. */ var params = { desiredCount: 10, loadBalancers: [ { containerName: "simple-app", containerPort: 80, loadBalancerName: "EC2Contai-EcsElast-15DCDAURT3ZO2" } ], role: "ecsServiceRole", serviceName: "ecs-simple-service-elb", taskDefinition: "console-sample-app-static" }; ecs.createService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { service: { clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", createdAt: <Date Representation>, deploymentConfiguration: { maximumPercent: 200, minimumHealthyPercent: 100 }, deployments: [ { createdAt: <Date Representation>, desiredCount: 10, id: "ecs-svc/9223370564343000923", pendingCount: 0, runningCount: 0, status: "PRIMARY", taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", updatedAt: <Date Representation> } ], desiredCount: 10, events: [ ], loadBalancers: [ { containerName: "simple-app", containerPort: 80, loadBalancerName: "EC2Contai-EcsElast-15DCDAURT3ZO2" } ], pendingCount: 0, roleArn: "arn:aws:iam::012345678910:role/ecsServiceRole", runningCount: 0, serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service-elb", serviceName: "ecs-simple-service-elb", status: "ACTIVE", taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/console-sample-app-static:6" } } */ });
Calling the createService operation
var params = { serviceName: 'STRING_VALUE', /* required */ capacityProviderStrategy: [ { capacityProvider: 'STRING_VALUE', /* required */ base: 'NUMBER_VALUE', weight: 'NUMBER_VALUE' }, /* more items */ ], clientToken: 'STRING_VALUE', cluster: 'STRING_VALUE', deploymentConfiguration: { alarms: { alarmNames: [ /* required */ 'STRING_VALUE', /* more items */ ], enable: true || false, /* required */ rollback: true || false /* required */ }, deploymentCircuitBreaker: { enable: true || false, /* required */ rollback: true || false /* required */ }, maximumPercent: 'NUMBER_VALUE', minimumHealthyPercent: 'NUMBER_VALUE' }, deploymentController: { type: ECS | CODE_DEPLOY | EXTERNAL /* required */ }, desiredCount: 'NUMBER_VALUE', enableECSManagedTags: true || false, enableExecuteCommand: true || false, healthCheckGracePeriodSeconds: 'NUMBER_VALUE', launchType: EC2 | FARGATE | EXTERNAL, loadBalancers: [ { containerName: 'STRING_VALUE', containerPort: 'NUMBER_VALUE', loadBalancerName: 'STRING_VALUE', targetGroupArn: 'STRING_VALUE' }, /* more items */ ], networkConfiguration: { awsvpcConfiguration: { subnets: [ /* required */ 'STRING_VALUE', /* more items */ ], assignPublicIp: ENABLED | DISABLED, securityGroups: [ 'STRING_VALUE', /* more items */ ] } }, placementConstraints: [ { expression: 'STRING_VALUE', type: distinctInstance | memberOf }, /* more items */ ], placementStrategy: [ { field: 'STRING_VALUE', type: random | spread | binpack }, /* more items */ ], platformVersion: 'STRING_VALUE', propagateTags: TASK_DEFINITION | SERVICE | NONE, role: 'STRING_VALUE', schedulingStrategy: REPLICA | DAEMON, serviceConnectConfiguration: { enabled: true || false, /* required */ logConfiguration: { logDriver: json-file | syslog | journald | gelf | fluentd | awslogs | splunk | awsfirelens, /* required */ options: { '<String>': 'STRING_VALUE', /* '<String>': ... */ }, secretOptions: [ { name: 'STRING_VALUE', /* required */ valueFrom: 'STRING_VALUE' /* required */ }, /* more items */ ] }, namespace: 'STRING_VALUE', services: [ { portName: 'STRING_VALUE', /* required */ clientAliases: [ { port: 'NUMBER_VALUE', /* required */ dnsName: 'STRING_VALUE' }, /* more items */ ], discoveryName: 'STRING_VALUE', ingressPortOverride: 'NUMBER_VALUE', timeout: { idleTimeoutSeconds: 'NUMBER_VALUE', perRequestTimeoutSeconds: 'NUMBER_VALUE' }, tls: { issuerCertificateAuthority: { /* required */ awsPcaAuthorityArn: 'STRING_VALUE' }, kmsKey: 'STRING_VALUE', roleArn: 'STRING_VALUE' } }, /* more items */ ] }, serviceRegistries: [ { containerName: 'STRING_VALUE', containerPort: 'NUMBER_VALUE', port: 'NUMBER_VALUE', registryArn: 'STRING_VALUE' }, /* more items */ ], tags: [ { key: 'STRING_VALUE', value: 'STRING_VALUE' }, /* more items */ ], taskDefinition: 'STRING_VALUE', volumeConfigurations: [ { name: 'STRING_VALUE', /* required */ managedEBSVolume: { roleArn: 'STRING_VALUE', /* required */ encrypted: true || false, filesystemType: ext3 | ext4 | xfs, iops: 'NUMBER_VALUE', kmsKeyId: 'STRING_VALUE', sizeInGiB: 'NUMBER_VALUE', snapshotId: 'STRING_VALUE', tagSpecifications: [ { resourceType: volume, /* required */ propagateTags: TASK_DEFINITION | SERVICE | NONE, tags: [ { key: 'STRING_VALUE', value: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], throughput: 'NUMBER_VALUE', volumeType: 'STRING_VALUE' } }, /* more items */ ] }; ecs.createService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
serviceName
— (String
)The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
taskDefinition
— (String
)The
family
andrevision
(family:revision
) or full ARN of the task definition to run in your service. If arevision
isn't specified, the latestACTIVE
revision is used.A task definition must be specified if the service uses either the
ECS
orCODE_DEPLOY
deployment controllers.For more information about deployment types, see Amazon ECS deployment types.
loadBalancers
— (Array<map>
)A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
If the service uses the rolling update (
ECS
) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.If the service uses the
CODE_DEPLOY
deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as atargetGroupPair
). During a deployment, CodeDeploy determines which task set in your service has the statusPRIMARY
, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.If you use the
CODE_DEPLOY
deployment controller, these values can be changed when updating the service.For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.
Services with tasks that use the
awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must chooseip
as the target type, notinstance
. This is because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Note: Each service may be associated with one service registry. Multiple service registries for each service isn't supported.registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
desiredCount
— (Integer
)The number of instantiations of the specified task definition to place and keep running in your service.
This is required if
schedulingStrategy
isREPLICA
or isn't specified. IfschedulingStrategy
isDAEMON
then this isn't required.clientToken
— (String
)An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
launchType
— (String
)The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The
FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.Note: Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.The
EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.The
EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.A service can use either a launch type or a capacity provider strategy. If a
Possible values include:launchType
is specified, thecapacityProviderStrategy
parameter must be omitted."EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy to use for the service.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.A capacity provider strategy may contain a maximum of 6 capacity providers.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.role
— (String
)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 only permitted if you are using a load balancer with your service and your task definition doesn't use the
awsvpc
network mode. If you specify therole
parameter, you must also specify a load balancer object with theloadBalancers
parameter.If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpc
network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.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 namebar
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
— (map
)Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentCircuitBreaker
— (map
)Note: The deployment circuit breaker can only be used for services using the rolling update (ECS
) deployment type.The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide
enable
— required — (Boolean
)Determines whether to use the deployment circuit breaker logic for the service.
rollback
— required — (Boolean
)Determines 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.
maximumPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, themaximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in theRUNNING
orPENDING
state during a deployment, as a percentage of thedesiredCount
(rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using theREPLICA
service scheduler and has adesiredCount
of four tasks and amaximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The defaultmaximumPercent
value for a service using theREPLICA
service scheduler is 200%.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.minimumHealthyPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, theminimumHealthyPercent
represents a lower limit on the number of your service's tasks that must remain in theRUNNING
state during a deployment, as a percentage of thedesiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has adesiredCount
of four tasks and aminimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.For services that do not use a load balancer, the following should be noted:
-
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
-
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a
RUNNING
state before the task is counted towards the minimum healthy percent total. -
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
-
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
-
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
The default value for a replica service for
minimumHealthyPercent
is 100%. The defaultminimumHealthyPercent
value for a service using theDAEMON
service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.The minimum number of healthy tasks during a deployment is the
desiredCount
multiplied by theminimumHealthyPercent
/100, rounded up to the nearest integer value.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.-
alarms
— (map
)Information about the CloudWatch alarms.
alarmNames
— required — (Array<String>
)One or more CloudWatch alarm names. Use a "," to separate the alarms.
enable
— required — (Boolean
)Determines whether to use the CloudWatch alarm option in the service deployment process.
rollback
— required — (Boolean
)Determines 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.
placementConstraints
— (Array<map>
)An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
type
— (String
)The type of constraint. Use
Possible values include:distinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates."distinctInstance"
"memberOf"
expression
— (String
)A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is
distinctInstance
. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
placementStrategy
— (Array<map>
)The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
type
— (String
)The type of placement strategy. The
Possible values include:random
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that's specified with thefield
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."random"
"spread"
"binpack"
field
— (String
)The field to apply the placement strategy against. For the
spread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that's applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used.
networkConfiguration
— (map
)The network configuration for the service. This parameter is required for task definitions that use the
awsvpc
network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
healthCheckGracePeriodSeconds
— (Integer
)The 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. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of
0
is used.If you do not use an Elastic Load Balancing, we recommend that you use the
startPeriod
in the task definition health check parameters. For more information, see Health check.If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
schedulingStrategy
— (String
)The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
-
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses theCODE_DEPLOY
orEXTERNAL
deployment controller types. -
DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.Note: Tasks using the Fargate launch type or theCODE_DEPLOY
orEXTERNAL
deployment controller types don't support theDAEMON
scheduling strategy.
"REPLICA"
"DAEMON"
-
deploymentController
— (map
)The deployment controller to use for the service. If no deployment controller is specified, the default value of
ECS
is used.type
— required — (String
)The deployment controller type to use.
There are three deployment controller types available:
- ECS
-
The rolling update (
ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
-
The blue/green (
CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
-
The external (
EXTERNAL
) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
"ECS"
"CODE_DEPLOY"
"EXTERNAL"
tags
— (Array<map>
)The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
enableECSManagedTags
— (Boolean
)Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.
When you use Amazon ECS managed tags, you need to set the
propagateTags
request parameter.propagateTags
— (String
)Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than
NONE
when you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide.The default is
Possible values include:NONE
."TASK_DEFINITION"
"SERVICE"
"NONE"
enableExecuteCommand
— (Boolean
)Determines whether the execute command functionality is turned on for the service. If
true
, this enables execute command functionality on all containers in the service tasks.serviceConnectConfiguration
— (map
)The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
enabled
— required — (Boolean
)Specifies whether to use Service Connect with this service.
namespace
— (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
services
— (Array<map>
)The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
portName
— required — (String
)The
portName
must match the name of one of theportMappings
from all the containers in the task definition of this Amazon ECS service.discoveryName
— (String
)The
discoveryName
is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.If the
discoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.clientAliases
— (Array<map>
)The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each
ServiceConnectService
, you must provide at least oneclientAlias
with oneport
.port
— required — (Integer
)The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
dnsName
— (String
)The
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. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.If this parameter isn't specified, the default value of
discoveryName.namespace
is used. If thediscoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are
database
,db
, or the lowercase name of a database, such asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
ingressPortOverride
— (Integer
)The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port number specified in the named
portMapping
in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.In
awsvpc
mode and Fargate, the default value is the container port number. The container port number is in theportMapping
in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.timeout
— (map
)A reference to an object that represents the configured timeouts for Service Connect.
idleTimeoutSeconds
— (Integer
)The amount of time in seconds a connection will stay active while idle. A value of
0
can be set to disableidleTimeout
.The
idleTimeout
default forHTTP
/HTTP2
/GRPC
is 5 minutes.The
idleTimeout
default forTCP
is 1 hour.perRequestTimeoutSeconds
— (Integer
)The amount of time waiting for the upstream to respond with a complete response per request. A value of
0
can be set to disableperRequestTimeout
.perRequestTimeout
can only be set if Service ConnectappProtocol
isn'tTCP
. OnlyidleTimeout
is allowed forTCP
appProtocol
.
tls
— (map
)A reference to an object that represents a Transport Layer Security (TLS) configuration.
issuerCertificateAuthority
— required — (map
)The signer certificate authority.
awsPcaAuthorityArn
— (String
)The ARN of the Amazon Web Services Private Certificate Authority certificate.
kmsKey
— (String
)The Amazon Web Services Key Management Service key.
roleArn
— (String
)The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.
logConfiguration
— (map
)The log configuration for the container. This parameter maps to
LogConfig
in the docker conainer create command and the--log-driver
option to docker run.By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.
Understand the following when specifying a log configuration for your containers.
-
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
. -
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
-
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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 Elastic Container Service Developer Guide. -
For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
logDriver
— required — (String
)The log driver to use for the container.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.Possible values include:"json-file"
"syslog"
"journald"
"gelf"
"fluentd"
"awslogs"
"splunk"
"awsfirelens"
options
— (map<String>
)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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
secretOptions
— (Array<map>
)The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
-
volumeConfigurations
— (Array<map>
)The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
name
— required — (String
)The name of the volume. This value must match the volume name from the
Volume
object in the task definition.managedEBSVolume
— (map
)The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.
encrypted
— (Boolean
)Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the
Encrypted
parameter of the CreateVolume API in the Amazon EC2 API Reference.kmsKeyId
— (String
)The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the
KmsKeyId
parameter of the CreateVolume API in the Amazon EC2 API Reference.Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
volumeType
— (String
)The volume type. This parameter maps 1:1 with the
VolumeType
parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.The following are the supported volume types.
-
General Purpose SSD:
gp2
|gp3
-
Provisioned IOPS SSD:
io1
|io2
-
Throughput Optimized HDD:
st1
-
Cold HDD:
sc1
-
Magnetic:
standard
Note: The magnetic volume type is not supported on Fargate.
-
sizeInGiB
— (Integer
)The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
Size
parameter of the CreateVolume API in the Amazon EC2 API Reference.The following are the supported volume size values for each volume type.
-
gp2
andgp3
: 1-16,384 -
io1
andio2
: 4-16,384 -
st1
andsc1
: 125-16,384 -
standard
: 1-1,024
-
snapshotId
— (String
)The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the
SnapshotId
parameter of the CreateVolume API in the Amazon EC2 API Reference.iops
— (Integer
)The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type.
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
This parameter is required for
io1
andio2
volume types. The default forgp3
volumes is3,000 IOPS
. This parameter is not supported forst1
,sc1
, orstandard
volume types.This parameter maps 1:1 with the
Iops
parameter of the CreateVolume API in the Amazon EC2 API Reference.-
throughput
— (Integer
)The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the
Throughput
parameter of the CreateVolume API in the Amazon EC2 API Reference.This parameter is only supported for the
gp3
volume type.tagSpecifications
— (Array<map>
)The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the
TagSpecifications.N
parameter of the CreateVolume API in the Amazon EC2 API Reference.resourceType
— required — (String
)The type of volume resource.
Possible values include:"volume"
tags
— (Array<map>
)The tags applied to this Amazon EBS volume.
AmazonECSCreated
andAmazonECSManaged
are reserved tags that can't be used.key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
propagateTags
— (String
)Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a
Possible values include:SERVICE
specified inServiceVolumeConfiguration
. If no value is specified, the tags aren't propagated."TASK_DEFINITION"
"SERVICE"
"NONE"
roleArn
— required — (String
)The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed
AmazonECSInfrastructureRolePolicyForVolumes
IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.filesystemType
— (String
)The 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.
The available filesystem types are
Possible values include:ext3
,ext4
, andxfs
. If no value is specified, thexfs
filesystem type is used by default."ext3"
"ext4"
"xfs"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:service
— (map
)The full description of your service following the create call.
A service will return either a
capacityProviderStrategy
orlaunchType
parameter, but not both, depending where one was specified when it was created.If a service is using the
ECS
deployment controller, thedeploymentController
andtaskSets
parameters will not be returned.if the service uses the
CODE_DEPLOY
deployment controller, thedeploymentController
,taskSets
anddeployments
parameters will be returned, however thedeployments
parameter will be an empty list.serviceArn
— (String
)The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
serviceName
— (String
)The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that hosts the service.
loadBalancers
— (Array<map>
)A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
status
— (String
)The status of the service. The valid values are
ACTIVE
,DRAINING
, orINACTIVE
.desiredCount
— (Integer
)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.
runningCount
— (Integer
)The number of tasks in the cluster that are in the
RUNNING
state.pendingCount
— (Integer
)The number of tasks in the cluster that are in the
PENDING
state.launchType
— (String
)The 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.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.platformFamily
— (String
)The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily
value as the service (for example,LINUX
).taskDefinition
— (String
)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
— (map
)Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentCircuitBreaker
— (map
)Note: The deployment circuit breaker can only be used for services using the rolling update (ECS
) deployment type.The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide
enable
— required — (Boolean
)Determines whether to use the deployment circuit breaker logic for the service.
rollback
— required — (Boolean
)Determines 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.
maximumPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, themaximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in theRUNNING
orPENDING
state during a deployment, as a percentage of thedesiredCount
(rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using theREPLICA
service scheduler and has adesiredCount
of four tasks and amaximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The defaultmaximumPercent
value for a service using theREPLICA
service scheduler is 200%.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.minimumHealthyPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, theminimumHealthyPercent
represents a lower limit on the number of your service's tasks that must remain in theRUNNING
state during a deployment, as a percentage of thedesiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has adesiredCount
of four tasks and aminimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.For services that do not use a load balancer, the following should be noted:
-
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
-
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a
RUNNING
state before the task is counted towards the minimum healthy percent total. -
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
-
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
-
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
The default value for a replica service for
minimumHealthyPercent
is 100%. The defaultminimumHealthyPercent
value for a service using theDAEMON
service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.The minimum number of healthy tasks during a deployment is the
desiredCount
multiplied by theminimumHealthyPercent
/100, rounded up to the nearest integer value.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.-
alarms
— (map
)Information about the CloudWatch alarms.
alarmNames
— required — (Array<String>
)One or more CloudWatch alarm names. Use a "," to separate the alarms.
enable
— required — (Boolean
)Determines whether to use the CloudWatch alarm option in the service deployment process.
rollback
— required — (Boolean
)Determines 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.
taskSets
— (Array<map>
)Information about a set of Amazon ECS tasks in either an CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.id
— (String
)The ID of the task set.
taskSetArn
— (String
)The Amazon Resource Name (ARN) of the task set.
serviceArn
— (String
)The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy
— (String
)The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
startedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.externalId
— (String
)The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.status
— (String
)The status of the task set. The following describes each state.
- PRIMARY
-
The task set is serving production traffic.
- ACTIVE
-
The task set isn't serving production traffic.
- DRAINING
-
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
taskDefinition
— (String
)The task definition that the task set is using.
computedDesiredCount
— (Integer
)The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.pendingCount
— (Integer
)The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.runningCount
— (Integer
)The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.createdAt
— (Date
)The Unix timestamp for the time when the task set was created.
updatedAt
— (Date
)The Unix timestamp for the time when the task set was last updated.
launchType
— (String
)The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that are associated with the task set.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
platformFamily
— (String
)The 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.
All tasks in the set must have the same value.
networkConfiguration
— (map
)The network configuration for the task set.
awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
loadBalancers
— (Array<map>
)Details on a load balancer that are used with a task set.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
scale
— (map
)A floating-point percentage of your desired number of tasks to place and keep running in the task set.
value
— (Float
)The value, specified as a percent total of a service's
desiredCount
, to scale the task set. Accepted values are numbers between 0 and 100.unit
— (String
)The unit of measure for the scale value.
Possible values include:"PERCENT"
stabilityStatus
— (String
)The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are running on container instances in the
DRAINING
status. -
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
Possible values include:STABILIZING
."STEADY_STATE"
"STABILIZING"
-
stabilityStatusAt
— (Date
)The Unix timestamp for the time when the task set stability status was retrieved.
tags
— (Array<map>
)The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the task set.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
deployments
— (Array<map>
)The current state of deployments for the service.
id
— (String
)The ID of the deployment.
status
— (String
)The status of the deployment. The following describes each state.
- PRIMARY
-
The most recent deployment of a service.
- ACTIVE
-
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment. - INACTIVE
-
A deployment that has been completely replaced.
taskDefinition
— (String
)The most recent task definition that was specified for the tasks in the service to use.
desiredCount
— (Integer
)The most recent desired count of tasks that was specified for the service to deploy or maintain.
pendingCount
— (Integer
)The number of tasks in the deployment that are in the
PENDING
status.runningCount
— (Integer
)The number of tasks in the deployment that are in the
RUNNING
status.failedTasks
— (Integer
)The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a
RUNNING
state, or if it fails any of its defined health checks and is stopped.Note: Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.createdAt
— (Date
)The Unix timestamp for the time when the service deployment was created.
updatedAt
— (Date
)The Unix timestamp for the time when the service deployment was last updated.
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that the deployment is using.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
launchType
— (String
)The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
platformVersion
— (String
)The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.platformFamily
— (String
)The 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.
All tasks that run as part of this service must use the same
platformFamily
value as the service, for example,LINUX.
.networkConfiguration
— (map
)The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode.awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
rolloutState
— (String
)Note: TherolloutState
of a service is only returned for services that use the rolling update (ECS
) deployment type that aren't behind a Classic Load Balancer.The rollout state of the deployment. When a service deployment is started, it begins in an
Possible values include:IN_PROGRESS
state. When the service reaches a steady state, the deployment transitions to aCOMPLETED
state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to aFAILED
state. A deployment inFAILED
state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker."COMPLETED"
"FAILED"
"IN_PROGRESS"
rolloutStateReason
— (String
)A description of the rollout state of a deployment.
serviceConnectConfiguration
— (map
)The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
enabled
— required — (Boolean
)Specifies whether to use Service Connect with this service.
namespace
— (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
services
— (Array<map>
)The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
portName
— required — (String
)The
portName
must match the name of one of theportMappings
from all the containers in the task definition of this Amazon ECS service.discoveryName
— (String
)The
discoveryName
is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.If the
discoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.clientAliases
— (Array<map>
)The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each
ServiceConnectService
, you must provide at least oneclientAlias
with oneport
.port
— required — (Integer
)The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
dnsName
— (String
)The
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. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.If this parameter isn't specified, the default value of
discoveryName.namespace
is used. If thediscoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are
database
,db
, or the lowercase name of a database, such asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
ingressPortOverride
— (Integer
)The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port number specified in the named
portMapping
in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.In
awsvpc
mode and Fargate, the default value is the container port number. The container port number is in theportMapping
in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.timeout
— (map
)A reference to an object that represents the configured timeouts for Service Connect.
idleTimeoutSeconds
— (Integer
)The amount of time in seconds a connection will stay active while idle. A value of
0
can be set to disableidleTimeout
.The
idleTimeout
default forHTTP
/HTTP2
/GRPC
is 5 minutes.The
idleTimeout
default forTCP
is 1 hour.perRequestTimeoutSeconds
— (Integer
)The amount of time waiting for the upstream to respond with a complete response per request. A value of
0
can be set to disableperRequestTimeout
.perRequestTimeout
can only be set if Service ConnectappProtocol
isn'tTCP
. OnlyidleTimeout
is allowed forTCP
appProtocol
.
tls
— (map
)A reference to an object that represents a Transport Layer Security (TLS) configuration.
issuerCertificateAuthority
— required — (map
)The signer certificate authority.
awsPcaAuthorityArn
— (String
)The ARN of the Amazon Web Services Private Certificate Authority certificate.
kmsKey
— (String
)The Amazon Web Services Key Management Service key.
roleArn
— (String
)The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.
logConfiguration
— (map
)The log configuration for the container. This parameter maps to
LogConfig
in the docker conainer create command and the--log-driver
option to docker run.By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.
Understand the following when specifying a log configuration for your containers.
-
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
. -
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
-
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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 Elastic Container Service Developer Guide. -
For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
logDriver
— required — (String
)The log driver to use for the container.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.Possible values include:"json-file"
"syslog"
"journald"
"gelf"
"fluentd"
"awslogs"
"splunk"
"awsfirelens"
options
— (map<String>
)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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
secretOptions
— (Array<map>
)The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
-
serviceConnectResources
— (Array<map>
)The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.
discoveryName
— (String
)The discovery name of this Service Connect resource.
The
discoveryName
is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.If the
discoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.discoveryArn
— (String
)The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.
volumeConfigurations
— (Array<map>
)The details of the volume that was
configuredAtLaunch
. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. Thename
of the volume must match thename
from the task definition.name
— required — (String
)The name of the volume. This value must match the volume name from the
Volume
object in the task definition.managedEBSVolume
— (map
)The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.
encrypted
— (Boolean
)Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the
Encrypted
parameter of the CreateVolume API in the Amazon EC2 API Reference.kmsKeyId
— (String
)The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the
KmsKeyId
parameter of the CreateVolume API in the Amazon EC2 API Reference.Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
volumeType
— (String
)The volume type. This parameter maps 1:1 with the
VolumeType
parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.The following are the supported volume types.
-
General Purpose SSD:
gp2
|gp3
-
Provisioned IOPS SSD:
io1
|io2
-
Throughput Optimized HDD:
st1
-
Cold HDD:
sc1
-
Magnetic:
standard
Note: The magnetic volume type is not supported on Fargate.
-
sizeInGiB
— (Integer
)The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
Size
parameter of the CreateVolume API in the Amazon EC2 API Reference.The following are the supported volume size values for each volume type.
-
gp2
andgp3
: 1-16,384 -
io1
andio2
: 4-16,384 -
st1
andsc1
: 125-16,384 -
standard
: 1-1,024
-
snapshotId
— (String
)The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the
SnapshotId
parameter of the CreateVolume API in the Amazon EC2 API Reference.iops
— (Integer
)The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type.
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
This parameter is required for
io1
andio2
volume types. The default forgp3
volumes is3,000 IOPS
. This parameter is not supported forst1
,sc1
, orstandard
volume types.This parameter maps 1:1 with the
Iops
parameter of the CreateVolume API in the Amazon EC2 API Reference.-
throughput
— (Integer
)The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the
Throughput
parameter of the CreateVolume API in the Amazon EC2 API Reference.This parameter is only supported for the
gp3
volume type.tagSpecifications
— (Array<map>
)The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the
TagSpecifications.N
parameter of the CreateVolume API in the Amazon EC2 API Reference.resourceType
— required — (String
)The type of volume resource.
Possible values include:"volume"
tags
— (Array<map>
)The tags applied to this Amazon EBS volume.
AmazonECSCreated
andAmazonECSManaged
are reserved tags that can't be used.key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
propagateTags
— (String
)Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a
Possible values include:SERVICE
specified inServiceVolumeConfiguration
. If no value is specified, the tags aren't propagated."TASK_DEFINITION"
"SERVICE"
"NONE"
roleArn
— required — (String
)The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed
AmazonECSInfrastructureRolePolicyForVolumes
IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.filesystemType
— (String
)The 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.
The available filesystem types are
Possible values include:ext3
,ext4
, andxfs
. If no value is specified, thexfs
filesystem type is used by default."ext3"
"ext4"
"xfs"
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the deployment.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
roleArn
— (String
)The 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.
events
— (Array<map>
)The event stream for your service. A maximum of 100 of the latest events are displayed.
id
— (String
)The ID string for the event.
createdAt
— (Date
)The Unix timestamp for the time when the event was triggered.
message
— (String
)The event message.
createdAt
— (Date
)The Unix timestamp for the time when the service was created.
placementConstraints
— (Array<map>
)The placement constraints for the tasks in the service.
type
— (String
)The type of constraint. Use
Possible values include:distinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates."distinctInstance"
"memberOf"
expression
— (String
)A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is
distinctInstance
. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
placementStrategy
— (Array<map>
)The placement strategy that determines how tasks for the service are placed.
type
— (String
)The type of placement strategy. The
Possible values include:random
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that's specified with thefield
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."random"
"spread"
"binpack"
field
— (String
)The field to apply the placement strategy against. For the
spread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that's applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used.
networkConfiguration
— (map
)The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode.awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
healthCheckGracePeriodSeconds
— (Integer
)The 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.
schedulingStrategy
— (String
)The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
-
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. -
DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Note: Fargate tasks don't support theDAEMON
scheduling strategy.
"REPLICA"
"DAEMON"
-
deploymentController
— (map
)The deployment controller type the service is using.
type
— required — (String
)The deployment controller type to use.
There are three deployment controller types available:
- ECS
-
The rolling update (
ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
-
The blue/green (
CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
-
The external (
EXTERNAL
) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
"ECS"
"CODE_DEPLOY"
"EXTERNAL"
tags
— (Array<map>
)The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
createdBy
— (String
)The principal that created the service.
enableECSManagedTags
— (Boolean
)Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
propagateTags
— (String
)Determines 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.
Possible values include:"TASK_DEFINITION"
"SERVICE"
"NONE"
enableExecuteCommand
— (Boolean
)Determines 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.
-
(AWS.Response)
—
Returns:
createTaskSet(params = {}, callback) ⇒ AWS.Request
Create a task set in the specified cluster and service. This is used when a service uses the
EXTERNAL
deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.Note: On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.For information about the maximum number of task sets and other quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.
Service Reference:
Examples:
Calling the createTaskSet operation
var params = { cluster: 'STRING_VALUE', /* required */ service: 'STRING_VALUE', /* required */ taskDefinition: 'STRING_VALUE', /* required */ capacityProviderStrategy: [ { capacityProvider: 'STRING_VALUE', /* required */ base: 'NUMBER_VALUE', weight: 'NUMBER_VALUE' }, /* more items */ ], clientToken: 'STRING_VALUE', externalId: 'STRING_VALUE', launchType: EC2 | FARGATE | EXTERNAL, loadBalancers: [ { containerName: 'STRING_VALUE', containerPort: 'NUMBER_VALUE', loadBalancerName: 'STRING_VALUE', targetGroupArn: 'STRING_VALUE' }, /* more items */ ], networkConfiguration: { awsvpcConfiguration: { subnets: [ /* required */ 'STRING_VALUE', /* more items */ ], assignPublicIp: ENABLED | DISABLED, securityGroups: [ 'STRING_VALUE', /* more items */ ] } }, platformVersion: 'STRING_VALUE', scale: { unit: PERCENT, value: 'NUMBER_VALUE' }, serviceRegistries: [ { containerName: 'STRING_VALUE', containerPort: 'NUMBER_VALUE', port: 'NUMBER_VALUE', registryArn: 'STRING_VALUE' }, /* more items */ ], tags: [ { key: 'STRING_VALUE', value: 'STRING_VALUE' }, /* more items */ ] }; ecs.createTaskSet(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
service
— (String
)The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
externalId
— (String
)An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the
ECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute set to the provided value.taskDefinition
— (String
)The task definition for the tasks in the task set to use. If a revision isn't specified, the latest
ACTIVE
revision is used.networkConfiguration
— (map
)An object representing the network configuration for a task set.
awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
loadBalancers
— (Array<map>
)A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
launchType
— (String
)The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
If a
Possible values include:launchType
is specified, thecapacityProviderStrategy
parameter must be omitted."EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the
base
andweight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation.
To use a Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the
LATEST
platform version is used.scale
— (map
)A floating-point percentage of the desired number of tasks to place and keep running in the task set.
value
— (Float
)The value, specified as a percent total of a service's
desiredCount
, to scale the task set. Accepted values are numbers between 0 and 100.unit
— (String
)The unit of measure for the scale value.
Possible values include:"PERCENT"
clientToken
— (String
)An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
tags
— (Array<map>
)The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:taskSet
— (map
)Information about a set of Amazon ECS tasks in either an CodeDeploy or an
EXTERNAL
deployment. A task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.id
— (String
)The ID of the task set.
taskSetArn
— (String
)The Amazon Resource Name (ARN) of the task set.
serviceArn
— (String
)The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy
— (String
)The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
startedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.externalId
— (String
)The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.status
— (String
)The status of the task set. The following describes each state.
- PRIMARY
-
The task set is serving production traffic.
- ACTIVE
-
The task set isn't serving production traffic.
- DRAINING
-
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
taskDefinition
— (String
)The task definition that the task set is using.
computedDesiredCount
— (Integer
)The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.pendingCount
— (Integer
)The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.runningCount
— (Integer
)The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.createdAt
— (Date
)The Unix timestamp for the time when the task set was created.
updatedAt
— (Date
)The Unix timestamp for the time when the task set was last updated.
launchType
— (String
)The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that are associated with the task set.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
platformFamily
— (String
)The 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.
All tasks in the set must have the same value.
networkConfiguration
— (map
)The network configuration for the task set.
awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
loadBalancers
— (Array<map>
)Details on a load balancer that are used with a task set.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
scale
— (map
)A floating-point percentage of your desired number of tasks to place and keep running in the task set.
value
— (Float
)The value, specified as a percent total of a service's
desiredCount
, to scale the task set. Accepted values are numbers between 0 and 100.unit
— (String
)The unit of measure for the scale value.
Possible values include:"PERCENT"
stabilityStatus
— (String
)The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are running on container instances in the
DRAINING
status. -
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
Possible values include:STABILIZING
."STEADY_STATE"
"STABILIZING"
-
stabilityStatusAt
— (Date
)The Unix timestamp for the time when the task set stability status was retrieved.
tags
— (Array<map>
)The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the task set.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
-
(AWS.Response)
—
Returns:
deleteAccountSetting(params = {}, callback) ⇒ AWS.Request
Disables an account setting for a specified user, role, or the root user for an account.
Service Reference:
Examples:
To delete your account setting
/* This example deletes the account setting for your user for the specified resource type. */ var params = { name: "serviceLongArnFormat" }; ecs.deleteAccountSetting(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { setting: { name: "serviceLongArnFormat", value: "enabled", principalArn: "arn:aws:iam::<aws_account_id>:user/principalName" } } */ });
To delete the account settings for a specific IAM user or IAM role
/* This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user. */ var params = { name: "containerInstanceLongArnFormat", principalArn: "arn:aws:iam::<aws_account_id>:user/principalName" }; ecs.deleteAccountSetting(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { setting: { name: "containerInstanceLongArnFormat", value: "enabled", principalArn: "arn:aws:iam::<aws_account_id>:user/principalName" } } */ });
Calling the deleteAccountSetting operation
var params = { name: serviceLongArnFormat | taskLongArnFormat | containerInstanceLongArnFormat | awsvpcTrunking | containerInsights | fargateFIPSMode | tagResourceAuthorization | fargateTaskRetirementWaitPeriod | guardDutyActivate, /* required */ principalArn: 'STRING_VALUE' }; ecs.deleteAccountSetting(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
name
— (String
)The resource name to disable the account setting for. If
Possible values include:serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. IftaskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. IfcontainerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected. IfawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container instances is affected."serviceLongArnFormat"
"taskLongArnFormat"
"containerInstanceLongArnFormat"
"awsvpcTrunking"
"containerInsights"
"fargateFIPSMode"
"tagResourceAuthorization"
"fargateTaskRetirementWaitPeriod"
"guardDutyActivate"
principalArn
— (String
)The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:setting
— (map
)The account setting for the specified principal ARN.
name
— (String
)The Amazon ECS resource name.
Possible values include:"serviceLongArnFormat"
"taskLongArnFormat"
"containerInstanceLongArnFormat"
"awsvpcTrunking"
"containerInsights"
"fargateFIPSMode"
"tagResourceAuthorization"
"fargateTaskRetirementWaitPeriod"
"guardDutyActivate"
value
— (String
)Determines whether the account setting is on or off for the specified resource.
principalArn
— (String
)The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.
type
— (String
)Indicates whether Amazon Web Services manages the account setting, or if the user manages it.
aws_managed
account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, theguardDutyActivate
account setting is the only one Amazon Web Services manages."user"
"aws_managed"
-
(AWS.Response)
—
Returns:
deleteAttributes(params = {}, callback) ⇒ AWS.Request
Deletes one or more custom attributes from an Amazon ECS resource.
Service Reference:
Examples:
Calling the deleteAttributes operation
var params = { attributes: [ /* required */ { name: 'STRING_VALUE', /* required */ targetId: 'STRING_VALUE', targetType: container-instance, value: 'STRING_VALUE' }, /* more items */ ], cluster: 'STRING_VALUE' }; ecs.deleteAttributes(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
attributes
— (Array<map>
)The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.
name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:attributes
— (Array<map>
)A list of attribute objects that were successfully deleted from your resource.
name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
-
(AWS.Response)
—
Returns:
deleteCapacityProvider(params = {}, callback) ⇒ AWS.Request
Deletes the specified capacity provider.
Note: TheFARGATE
andFARGATE_SPOT
capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the cluster.Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the
forceNewDeployment
option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutCapacityProviderProviders or delete the cluster.Service Reference:
Examples:
Calling the deleteCapacityProvider operation
var params = { capacityProvider: 'STRING_VALUE' /* required */ }; ecs.deleteCapacityProvider(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
capacityProvider
— (String
)The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:capacityProvider
— (map
)The details of the capacity provider.
capacityProviderArn
— (String
)The Amazon Resource Name (ARN) that identifies the capacity provider.
name
— (String
)The name of the capacity provider.
status
— (String
)The current status of the capacity provider. Only capacity providers in an
Possible values include:ACTIVE
state can be used in a cluster. When a capacity provider is successfully deleted, it has anINACTIVE
status."ACTIVE"
"INACTIVE"
autoScalingGroupProvider
— (map
)The Auto Scaling group settings for the capacity provider.
autoScalingGroupArn
— required — (String
)The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
managedScaling
— (map
)The managed scaling settings for the Auto Scaling group capacity provider.
status
— (String
)Determines whether to use managed scaling for the capacity provider.
Possible values include:"ENABLED"
"DISABLED"
targetCapacity
— (Integer
)The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than
0
and less than or equal to100
. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use atargetCapacity
of90
. The default value of100
percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.minimumScalingStepSize
— (Integer
)The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of
1
is used.When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
maximumScalingStepSize
— (Integer
)The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of
10000
is used.instanceWarmupPeriod
— (Integer
)The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of
300
seconds is used.
managedTerminationProtection
— (String
)The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
Possible values include:"ENABLED"
"DISABLED"
managedDraining
— (String
)The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
Possible values include:"ENABLED"
"DISABLED"
updateStatus
— (String
)The update status of the capacity provider. The following are the possible states that is returned.
- DELETE_IN_PROGRESS
-
The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
-
The capacity provider was successfully deleted and has an
INACTIVE
status. - DELETE_FAILED
-
The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
"DELETE_IN_PROGRESS"
"DELETE_COMPLETE"
"DELETE_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_COMPLETE"
"UPDATE_FAILED"
updateStatusReason
— (String
)The update status reason. This provides further details about the update status for the capacity provider.
tags
— (Array<map>
)The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
-
(AWS.Response)
—
Returns:
deleteCluster(params = {}, callback) ⇒ AWS.Request
Deletes the specified cluster. The cluster transitions to the
INACTIVE
state. Clusters with anINACTIVE
status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVE
clusters persisting.You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
Service Reference:
Examples:
To delete an empty cluster
/* This example deletes an empty cluster in your default region. */ var params = { cluster: "my_cluster" }; ecs.deleteCluster(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { cluster: { activeServicesCount: 0, clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", clusterName: "my_cluster", pendingTasksCount: 0, registeredContainerInstancesCount: 0, runningTasksCount: 0, status: "INACTIVE" } } */ });
Calling the deleteCluster operation
var params = { cluster: 'STRING_VALUE' /* required */ }; ecs.deleteCluster(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:cluster
— (map
)The full description of the deleted cluster.
clusterArn
— (String
)The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
clusterName
— (String
)A user-generated string that you use to identify your cluster.
configuration
— (map
)The execute command configuration for the cluster.
executeCommandConfiguration
— (map
)The details of the execute command configuration.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the data between the local client and the container.
logging
— (String
)The log setting to use for redirecting logs for your execute command results. The following log settings are available.
-
NONE
: The execute command session is not logged. -
DEFAULT
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged. -
OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.
"NONE"
"DEFAULT"
"OVERRIDE"
-
logConfiguration
— (map
)The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE
is specified, alogConfiguration
must be provided.cloudWatchLogGroupName
— (String
)The name of the CloudWatch log group to send logs to.
Note: The CloudWatch log group must already be created.cloudWatchEncryptionEnabled
— (Boolean
)Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
s3BucketName
— (String
)The name of the S3 bucket to send logs to.
Note: The S3 bucket must already be created.s3EncryptionEnabled
— (Boolean
)Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
s3KeyPrefix
— (String
)An optional folder in the S3 bucket to place logs in.
managedStorageConfiguration
— (map
)The details of the managed storage configuration.
kmsKeyId
— (String
)Specify a Key Management Service key ID to encrypt the managed storage.
fargateEphemeralStorageKmsKeyId
— (String
)Specify the Key Management Service key ID for the Fargate ephemeral storage.
status
— (String
)The status of the cluster. The following are the possible states that are returned.
- ACTIVE
-
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
-
The cluster has been deleted. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVE
clusters persisting.
registeredContainerInstancesCount
— (Integer
)The number of container instances registered into the cluster. This includes container instances in both
ACTIVE
andDRAINING
status.runningTasksCount
— (Integer
)The number of tasks in the cluster that are in the
RUNNING
state.pendingTasksCount
— (Integer
)The number of tasks in the cluster that are in the
PENDING
state.activeServicesCount
— (Integer
)The number of services that are running on the cluster in an
ACTIVE
state. You can view these services with PListServices.statistics
— (Array<map>
)Additional information about your clusters that are separated by launch type. They include the following:
-
runningEC2TasksCount
-
RunningFargateTasksCount
-
pendingEC2TasksCount
-
pendingFargateTasksCount
-
activeEC2ServiceCount
-
activeFargateServiceCount
-
drainingEC2ServiceCount
-
drainingFargateServiceCount
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
-
tags
— (Array<map>
)The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
settings
— (Array<map>
)The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.
name
— (String
)The name of the cluster setting. The value is
Possible values include:containerInsights
."containerInsights"
value
— (String
)The value to set for the cluster setting. The supported values are
enabled
anddisabled
.If you set
name
tocontainerInsights
andvalue
toenabled
, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless thecontainerInsights
account setting is turned on. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
capacityProviders
— (Array<String>
)The capacity providers associated with the cluster.
defaultCapacityProviderStrategy
— (Array<map>
)The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
attachments
— (Array<map>
)The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
id
— (String
)The unique identifier for the attachment.
type
— (String
)The type of the attachment, such as
ElasticNetworkInterface
,Service Connect
, andAmazonElasticBlockStorage
.status
— (String
)The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
,DELETED
, andFAILED
.details
— (Array<map>
)Details of the attachment.
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
For Service Connect services, this includes
portName
,clientAliases
,discoveryName
, andingressPortOverride
.For Elastic Block Storage, this includes
roleArn
,deleteOnTermination
,volumeName
,volumeId
, andstatusReason
(only when the attachment fails to create or attach).name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
attachmentsStatus
— (String
)The status of the capacity providers associated with the cluster. The following are the states that are returned.
- UPDATE_IN_PROGRESS
-
The available capacity providers for the cluster are updating.
- UPDATE_COMPLETE
-
The capacity providers have successfully updated.
- UPDATE_FAILED
-
The capacity provider updates failed.
serviceConnectDefaults
— (map
)Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the
enabled
parameter totrue
in theServiceConnectConfiguration
. You can set the namespace of each service individually in theServiceConnectConfiguration
to override this default parameter.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
namespace
— (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.
-
(AWS.Response)
—
Returns:
deleteService(params = {}, callback) ⇒ AWS.Request
Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can't delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
Note: When you delete a service, if there are still running tasks that require cleanup, the service status moves fromACTIVE
toDRAINING
, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to eitherSTOPPING
orSTOPPED
status, the service status moves fromDRAINING
toINACTIVE
. Services in theDRAINING
orINACTIVE
status can still be viewed with the DescribeServices API operation. However, in the future,INACTIVE
services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return aServiceNotFoundException
error.If you attempt to create a new service with the same name as an existing service in either
ACTIVE
orDRAINING
status, you receive an error.Service Reference:
Examples:
To delete a service
/* This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it. */ var params = { service: "my-http-service" }; ecs.deleteService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { } */ });
Calling the deleteService operation
var params = { service: 'STRING_VALUE', /* required */ cluster: 'STRING_VALUE', force: true || false }; ecs.deleteService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
service
— (String
)The name of the service to delete.
force
— (Boolean
)If
true
, allows you to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses theREPLICA
scheduling strategy.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:service
— (map
)The full description of the deleted service.
serviceArn
— (String
)The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
serviceName
— (String
)The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that hosts the service.
loadBalancers
— (Array<map>
)A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
status
— (String
)The status of the service. The valid values are
ACTIVE
,DRAINING
, orINACTIVE
.desiredCount
— (Integer
)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.
runningCount
— (Integer
)The number of tasks in the cluster that are in the
RUNNING
state.pendingCount
— (Integer
)The number of tasks in the cluster that are in the
PENDING
state.launchType
— (String
)The 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.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.platformFamily
— (String
)The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily
value as the service (for example,LINUX
).taskDefinition
— (String
)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
— (map
)Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentCircuitBreaker
— (map
)Note: The deployment circuit breaker can only be used for services using the rolling update (ECS
) deployment type.The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide
enable
— required — (Boolean
)Determines whether to use the deployment circuit breaker logic for the service.
rollback
— required — (Boolean
)Determines 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.
maximumPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, themaximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in theRUNNING
orPENDING
state during a deployment, as a percentage of thedesiredCount
(rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using theREPLICA
service scheduler and has adesiredCount
of four tasks and amaximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The defaultmaximumPercent
value for a service using theREPLICA
service scheduler is 200%.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.minimumHealthyPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, theminimumHealthyPercent
represents a lower limit on the number of your service's tasks that must remain in theRUNNING
state during a deployment, as a percentage of thedesiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has adesiredCount
of four tasks and aminimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.For services that do not use a load balancer, the following should be noted:
-
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
-
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a
RUNNING
state before the task is counted towards the minimum healthy percent total. -
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
-
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
-
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
The default value for a replica service for
minimumHealthyPercent
is 100%. The defaultminimumHealthyPercent
value for a service using theDAEMON
service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.The minimum number of healthy tasks during a deployment is the
desiredCount
multiplied by theminimumHealthyPercent
/100, rounded up to the nearest integer value.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.-
alarms
— (map
)Information about the CloudWatch alarms.
alarmNames
— required — (Array<String>
)One or more CloudWatch alarm names. Use a "," to separate the alarms.
enable
— required — (Boolean
)Determines whether to use the CloudWatch alarm option in the service deployment process.
rollback
— required — (Boolean
)Determines 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.
taskSets
— (Array<map>
)Information about a set of Amazon ECS tasks in either an CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.id
— (String
)The ID of the task set.
taskSetArn
— (String
)The Amazon Resource Name (ARN) of the task set.
serviceArn
— (String
)The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy
— (String
)The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
startedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.externalId
— (String
)The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.status
— (String
)The status of the task set. The following describes each state.
- PRIMARY
-
The task set is serving production traffic.
- ACTIVE
-
The task set isn't serving production traffic.
- DRAINING
-
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
taskDefinition
— (String
)The task definition that the task set is using.
computedDesiredCount
— (Integer
)The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.pendingCount
— (Integer
)The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.runningCount
— (Integer
)The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.createdAt
— (Date
)The Unix timestamp for the time when the task set was created.
updatedAt
— (Date
)The Unix timestamp for the time when the task set was last updated.
launchType
— (String
)The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that are associated with the task set.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
platformFamily
— (String
)The 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.
All tasks in the set must have the same value.
networkConfiguration
— (map
)The network configuration for the task set.
awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
loadBalancers
— (Array<map>
)Details on a load balancer that are used with a task set.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
scale
— (map
)A floating-point percentage of your desired number of tasks to place and keep running in the task set.
value
— (Float
)The value, specified as a percent total of a service's
desiredCount
, to scale the task set. Accepted values are numbers between 0 and 100.unit
— (String
)The unit of measure for the scale value.
Possible values include:"PERCENT"
stabilityStatus
— (String
)The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are running on container instances in the
DRAINING
status. -
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
Possible values include:STABILIZING
."STEADY_STATE"
"STABILIZING"
-
stabilityStatusAt
— (Date
)The Unix timestamp for the time when the task set stability status was retrieved.
tags
— (Array<map>
)The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the task set.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
deployments
— (Array<map>
)The current state of deployments for the service.
id
— (String
)The ID of the deployment.
status
— (String
)The status of the deployment. The following describes each state.
- PRIMARY
-
The most recent deployment of a service.
- ACTIVE
-
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment. - INACTIVE
-
A deployment that has been completely replaced.
taskDefinition
— (String
)The most recent task definition that was specified for the tasks in the service to use.
desiredCount
— (Integer
)The most recent desired count of tasks that was specified for the service to deploy or maintain.
pendingCount
— (Integer
)The number of tasks in the deployment that are in the
PENDING
status.runningCount
— (Integer
)The number of tasks in the deployment that are in the
RUNNING
status.failedTasks
— (Integer
)The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a
RUNNING
state, or if it fails any of its defined health checks and is stopped.Note: Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.createdAt
— (Date
)The Unix timestamp for the time when the service deployment was created.
updatedAt
— (Date
)The Unix timestamp for the time when the service deployment was last updated.
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that the deployment is using.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
launchType
— (String
)The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
platformVersion
— (String
)The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.platformFamily
— (String
)The 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.
All tasks that run as part of this service must use the same
platformFamily
value as the service, for example,LINUX.
.networkConfiguration
— (map
)The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode.awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
rolloutState
— (String
)Note: TherolloutState
of a service is only returned for services that use the rolling update (ECS
) deployment type that aren't behind a Classic Load Balancer.The rollout state of the deployment. When a service deployment is started, it begins in an
Possible values include:IN_PROGRESS
state. When the service reaches a steady state, the deployment transitions to aCOMPLETED
state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to aFAILED
state. A deployment inFAILED
state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker."COMPLETED"
"FAILED"
"IN_PROGRESS"
rolloutStateReason
— (String
)A description of the rollout state of a deployment.
serviceConnectConfiguration
— (map
)The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
enabled
— required — (Boolean
)Specifies whether to use Service Connect with this service.
namespace
— (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
services
— (Array<map>
)The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
portName
— required — (String
)The
portName
must match the name of one of theportMappings
from all the containers in the task definition of this Amazon ECS service.discoveryName
— (String
)The
discoveryName
is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.If the
discoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.clientAliases
— (Array<map>
)The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each
ServiceConnectService
, you must provide at least oneclientAlias
with oneport
.port
— required — (Integer
)The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
dnsName
— (String
)The
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. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.If this parameter isn't specified, the default value of
discoveryName.namespace
is used. If thediscoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are
database
,db
, or the lowercase name of a database, such asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
ingressPortOverride
— (Integer
)The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port number specified in the named
portMapping
in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.In
awsvpc
mode and Fargate, the default value is the container port number. The container port number is in theportMapping
in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.timeout
— (map
)A reference to an object that represents the configured timeouts for Service Connect.
idleTimeoutSeconds
— (Integer
)The amount of time in seconds a connection will stay active while idle. A value of
0
can be set to disableidleTimeout
.The
idleTimeout
default forHTTP
/HTTP2
/GRPC
is 5 minutes.The
idleTimeout
default forTCP
is 1 hour.perRequestTimeoutSeconds
— (Integer
)The amount of time waiting for the upstream to respond with a complete response per request. A value of
0
can be set to disableperRequestTimeout
.perRequestTimeout
can only be set if Service ConnectappProtocol
isn'tTCP
. OnlyidleTimeout
is allowed forTCP
appProtocol
.
tls
— (map
)A reference to an object that represents a Transport Layer Security (TLS) configuration.
issuerCertificateAuthority
— required — (map
)The signer certificate authority.
awsPcaAuthorityArn
— (String
)The ARN of the Amazon Web Services Private Certificate Authority certificate.
kmsKey
— (String
)The Amazon Web Services Key Management Service key.
roleArn
— (String
)The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.
logConfiguration
— (map
)The log configuration for the container. This parameter maps to
LogConfig
in the docker conainer create command and the--log-driver
option to docker run.By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.
Understand the following when specifying a log configuration for your containers.
-
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
. -
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
-
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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 Elastic Container Service Developer Guide. -
For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
logDriver
— required — (String
)The log driver to use for the container.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.Possible values include:"json-file"
"syslog"
"journald"
"gelf"
"fluentd"
"awslogs"
"splunk"
"awsfirelens"
options
— (map<String>
)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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
secretOptions
— (Array<map>
)The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
-
serviceConnectResources
— (Array<map>
)The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.
discoveryName
— (String
)The discovery name of this Service Connect resource.
The
discoveryName
is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.If the
discoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.discoveryArn
— (String
)The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.
volumeConfigurations
— (Array<map>
)The details of the volume that was
configuredAtLaunch
. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. Thename
of the volume must match thename
from the task definition.name
— required — (String
)The name of the volume. This value must match the volume name from the
Volume
object in the task definition.managedEBSVolume
— (map
)The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.
encrypted
— (Boolean
)Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the
Encrypted
parameter of the CreateVolume API in the Amazon EC2 API Reference.kmsKeyId
— (String
)The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the
KmsKeyId
parameter of the CreateVolume API in the Amazon EC2 API Reference.Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
volumeType
— (String
)The volume type. This parameter maps 1:1 with the
VolumeType
parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.The following are the supported volume types.
-
General Purpose SSD:
gp2
|gp3
-
Provisioned IOPS SSD:
io1
|io2
-
Throughput Optimized HDD:
st1
-
Cold HDD:
sc1
-
Magnetic:
standard
Note: The magnetic volume type is not supported on Fargate.
-
sizeInGiB
— (Integer
)The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
Size
parameter of the CreateVolume API in the Amazon EC2 API Reference.The following are the supported volume size values for each volume type.
-
gp2
andgp3
: 1-16,384 -
io1
andio2
: 4-16,384 -
st1
andsc1
: 125-16,384 -
standard
: 1-1,024
-
snapshotId
— (String
)The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the
SnapshotId
parameter of the CreateVolume API in the Amazon EC2 API Reference.iops
— (Integer
)The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type.
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
This parameter is required for
io1
andio2
volume types. The default forgp3
volumes is3,000 IOPS
. This parameter is not supported forst1
,sc1
, orstandard
volume types.This parameter maps 1:1 with the
Iops
parameter of the CreateVolume API in the Amazon EC2 API Reference.-
throughput
— (Integer
)The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the
Throughput
parameter of the CreateVolume API in the Amazon EC2 API Reference.This parameter is only supported for the
gp3
volume type.tagSpecifications
— (Array<map>
)The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the
TagSpecifications.N
parameter of the CreateVolume API in the Amazon EC2 API Reference.resourceType
— required — (String
)The type of volume resource.
Possible values include:"volume"
tags
— (Array<map>
)The tags applied to this Amazon EBS volume.
AmazonECSCreated
andAmazonECSManaged
are reserved tags that can't be used.key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
propagateTags
— (String
)Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a
Possible values include:SERVICE
specified inServiceVolumeConfiguration
. If no value is specified, the tags aren't propagated."TASK_DEFINITION"
"SERVICE"
"NONE"
roleArn
— required — (String
)The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed
AmazonECSInfrastructureRolePolicyForVolumes
IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.filesystemType
— (String
)The 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.
The available filesystem types are
Possible values include:ext3
,ext4
, andxfs
. If no value is specified, thexfs
filesystem type is used by default."ext3"
"ext4"
"xfs"
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the deployment.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
roleArn
— (String
)The 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.
events
— (Array<map>
)The event stream for your service. A maximum of 100 of the latest events are displayed.
id
— (String
)The ID string for the event.
createdAt
— (Date
)The Unix timestamp for the time when the event was triggered.
message
— (String
)The event message.
createdAt
— (Date
)The Unix timestamp for the time when the service was created.
placementConstraints
— (Array<map>
)The placement constraints for the tasks in the service.
type
— (String
)The type of constraint. Use
Possible values include:distinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates."distinctInstance"
"memberOf"
expression
— (String
)A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is
distinctInstance
. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
placementStrategy
— (Array<map>
)The placement strategy that determines how tasks for the service are placed.
type
— (String
)The type of placement strategy. The
Possible values include:random
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that's specified with thefield
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."random"
"spread"
"binpack"
field
— (String
)The field to apply the placement strategy against. For the
spread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that's applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used.
networkConfiguration
— (map
)The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode.awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
healthCheckGracePeriodSeconds
— (Integer
)The 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.
schedulingStrategy
— (String
)The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
-
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. -
DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Note: Fargate tasks don't support theDAEMON
scheduling strategy.
"REPLICA"
"DAEMON"
-
deploymentController
— (map
)The deployment controller type the service is using.
type
— required — (String
)The deployment controller type to use.
There are three deployment controller types available:
- ECS
-
The rolling update (
ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
-
The blue/green (
CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
-
The external (
EXTERNAL
) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
"ECS"
"CODE_DEPLOY"
"EXTERNAL"
tags
— (Array<map>
)The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
createdBy
— (String
)The principal that created the service.
enableECSManagedTags
— (Boolean
)Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
propagateTags
— (String
)Determines 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.
Possible values include:"TASK_DEFINITION"
"SERVICE"
"NONE"
enableExecuteCommand
— (Boolean
)Determines 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.
-
(AWS.Response)
—
Returns:
deleteTaskDefinitions(params = {}, callback) ⇒ AWS.Request
Deletes one or more task definitions.
You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.
When you delete a task definition revision, it is immediately transitions from the
INACTIVE
toDELETE_IN_PROGRESS
. Existing tasks and services that reference aDELETE_IN_PROGRESS
task definition revision continue to run without disruption. Existing services that reference aDELETE_IN_PROGRESS
task definition revision can still scale up or down by modifying the service's desired count.You can't use a
DELETE_IN_PROGRESS
task definition revision to run new tasks or create new services. You also can't update an existing service to reference aDELETE_IN_PROGRESS
task definition revision.A task definition revision will stay in
DELETE_IN_PROGRESS
status until all the associated tasks and services have been terminated.When you delete all
INACTIVE
task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in theDELETE_IN_PROGRESS
state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.Service Reference:
Examples:
Calling the deleteTaskDefinitions operation
var params = { taskDefinitions: [ /* required */ 'STRING_VALUE', /* more items */ ] }; ecs.deleteTaskDefinitions(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
taskDefinitions
— (Array<String>
)The
family
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to delete. You must specify arevision
.You can specify up to 10 task definitions as a comma separated list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:taskDefinitions
— (Array<map>
)The list of deleted task definitions.
taskDefinitionArn
— (String
)The full Amazon Resource Name (ARN) of the task definition.
containerDefinitions
— (Array<map>
)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 Elastic Container Service Developer Guide.
name
— (String
)The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in thelinks
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps toname
in tthe docker conainer create command and the--name
option to docker run.image
— (String
)The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
orrepository-url/image@digest
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImage
in the docker conainer create command and theIMAGE
parameter of docker run.-
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
-
Images in Amazon ECR repositories can be specified by either using the full
registry/repository:tag
orregistry/repository@digest
. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
. -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
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
).
-
repositoryCredentials
— (map
)The private repository authentication credentials to use.
credentialsParameter
— required — (String
)The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Note: When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
cpu
— (Integer
)The number of
cpu
units reserved for the container. This parameter maps toCpuShares
in the docker conainer create commandand the--cpu-shares
option to docker run.This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level
cpu
value.Note: 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.Linux containers share unallocated CPU units with other containers on the container 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, 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 two 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.
-
Agent versions greater than or equal to 1.84.0: CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as
0
, which Windows interprets as 1% of one CPU.-
memory
— (Integer
)The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memory
value, if one is specified. This parameter maps toMemory
in thethe docker conainer create command and the--memory
option to docker run.If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level
memory
andmemoryReservation
value,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
is used.The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memoryReservation
— (Integer
)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 toMemoryReservation
in the the docker conainer create command and the--memory-reservation
option to docker run.If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
ormemoryReservation
in a container definition. If you specify both,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
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 amemory
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.The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
links
— (Array<String>
)The
links
parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge
. Thename:internalName
construct is analogous toname:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps toLinks
in the docker conainer create command and the--link
option to docker run.Note: This parameter is not supported for Windows containers.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.
portMappings
— (Array<map>
)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.
For task definitions that use the
awsvpc
network mode, only specify thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.This parameter maps to
PortBindings
in the the docker conainer create command and the--publish
option to docker run. If the network mode of a task definition is set tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, then host ports must either be undefined or they must match the container port in the port mapping.Note: After a task reaches theRUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindings
section DescribeTasks responses.containerPort
— (Integer
)The port number on the container that's bound to the user-specified or automatically assigned host port.
If you use containers in a task with the
awsvpc
orhost
network mode, specify the exposed ports usingcontainerPort
.If you use containers in a task with the
bridge
network mode and 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, seehostPort
. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.hostPort
— (Integer
)The port number on the container instance to reserve for your container.
If you specify a
containerPortRange
, leave this field empty and the value of thehostPort
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPort
is set to the same value as thecontainerPort
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.
If you use containers in a task with the
awsvpc
orhost
network mode, thehostPort
can either be left blank or set to the same value as thecontainerPort
.If you use containers in a task with the
bridge
network mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort
(or set it to0
) while specifying acontainerPort
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 for Docker version 1.6.0 and later is listed on the instance under
/proc/sys/net/ipv4/ip_local_port_range
. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as 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 ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.-
protocol
— (String
)The protocol used for the port mapping. Valid values are
Possible values include:tcp
andudp
. The default istcp
.protocol
is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment."tcp"
"udp"
name
— (String
)The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfiguration
of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
appProtocol
— (String
)The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocol
is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
Possible values include:"http"
"http2"
"grpc"
containerPortRange
— (String
)The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a
containerPortRange
:-
You must use either the
bridge
network mode or theawsvpc
network mode. -
This parameter is available for both the EC2 and Fargate launch types.
-
This parameter is available for both the Linux and Windows operating systems.
-
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the
ecs-init
package -
You can specify a maximum of 100 port ranges per container.
-
You do not specify a
hostPortRange
. The value of thehostPortRange
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPortRange
is set to the same value as thecontainerPortRange
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
-
-
The
containerPortRange
valid values are between 1 and 65535. -
A port can only be included in one port mapping per container.
-
You cannot specify overlapping port ranges.
-
The first port in the range must be less than last port in the range.
-
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view thehostPortRange
which are the host ports that are bound to the container ports.-
essential
— (Boolean
)If the
essential
parameter of a container is marked astrue
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessential
parameter of a container is marked asfalse
, its failure doesn't 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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
restartPolicy
— (map
)The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
enabled
— required — (Boolean
)Specifies whether a restart policy is enabled for the container.
ignoredExitCodes
— (Array<Integer>
)A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.
restartAttemptPeriod
— (Integer
)A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every
restartAttemptPeriod
seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimumrestartAttemptPeriod
of 60 seconds and a maximumrestartAttemptPeriod
of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.
entryPoint
— (Array<String>
)Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
array items instead.The entry point that's passed to the container. This parameter maps to
Entrypoint
in tthe docker conainer create command and the--entrypoint
option to docker run.command
— (Array<String>
)The command that's passed to the container. This parameter maps to
Cmd
in the docker conainer create command and theCOMMAND
parameter to docker run. If there are multiple arguments, each argument is a separated string in the array.environment
— (Array<map>
)The environment variables to pass to a container. This parameter maps to
Env
in the docker conainer create command and the--env
option to docker run.We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
environmentFiles
— (Array<map>
)A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.You can specify up to ten environment files. The file must have a
.env
file extension. Each line in an environment file contains an environment variable inVARIABLE=VALUE
format. Lines beginning with#
are treated as comments and are ignored.If there are environment variables specified using the
environment
parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.value
— required — (String
)The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type
— required — (String
)The file type to use. Environment files are objects in Amazon S3. The only supported value is
Possible values include:s3
."s3"
mountPoints
— (Array<map>
)The mount points for data volumes in your container.
This parameter maps to
Volumes
in the the docker conainer create command and the--volume
option to docker run.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives.sourceVolume
— (String
)The name of the volume to mount. Must be a volume name referenced in the
name
parameter of task definitionvolume
.containerPath
— (String
)The path on the container to mount the host volume at.
readOnly
— (Boolean
)If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
volumesFrom
— (Array<map>
)Data volumes to mount from another container. This parameter maps to
VolumesFrom
in tthe docker conainer create command and the--volumes-from
option to docker run.sourceContainer
— (String
)The name of another container within the same task definition to mount volumes from.
readOnly
— (Boolean
)If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
linuxParameters
— (map
)Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
Note: This parameter is not supported for Windows containers.capabilities
— (map
)The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note: For tasks that use the Fargate launch type,capabilities
is supported for all platform versions but theadd
parameter is only supported if using platform version 1.4.0 or later.add
— (Array<String>
)The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAdd
in the docker conainer create command and the--cap-add
option to docker run.Note: Tasks launched on Fargate only support adding theSYS_PTRACE
kernel capability.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
drop
— (Array<String>
)The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDrop
in the docker conainer create command and the--cap-drop
option to docker run.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
devices
— (Array<map>
)Any host devices to expose to the container. This parameter maps to
Devices
in tthe docker conainer create command and the--device
option to docker run.Note: If you're using tasks that use the Fargate launch type, thedevices
parameter isn't supported.hostPath
— required — (String
)The path for the device on the host container instance.
containerPath
— (String
)The path inside the container at which to expose the host device.
permissions
— (Array<String>
)The explicit permissions to provide to the container for the device. By default, the container has permissions for
read
,write
, andmknod
for the device.
initProcessEnabled
— (Boolean
)Run an
init
process inside the container that forwards signals and reaps processes. This parameter maps to the--init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
sharedMemorySize
— (Integer
)The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run.Note: If you are using tasks that use the Fargate launch type, thesharedMemorySize
parameter is not supported.tmpfs
— (Array<map>
)The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run.Note: If you're using tasks that use the Fargate launch type, thetmpfs
parameter isn't supported.containerPath
— required — (String
)The absolute file path where the tmpfs volume is to be mounted.
size
— required — (Integer
)The maximum size (in MiB) of the tmpfs volume.
mountOptions
— (Array<String>
)The list of tmpfs volume mount options.
Valid values:
"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
maxSwap
— (Integer
)The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swap
option to docker run where the value would be the sum of the container memory plus themaxSwap
value.If a
maxSwap
value of0
is specified, the container will not use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
parameter to be used.Note: If you're using tasks that use the Fargate launch type, themaxSwap
parameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappiness
parameter isn't supported.swappiness
— (Integer
)This allows you to tune a container's memory swappiness behavior. A
swappiness
value of0
will cause swapping to not happen unless absolutely necessary. Aswappiness
value of100
will cause pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter is not specified, a default value of60
is used. If a value is not specified formaxSwap
then this parameter is ignored. This parameter maps to the--memory-swappiness
option to docker run.Note: If you're using tasks that use the Fargate launch type, theswappiness
parameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappiness
parameter isn't supported.
secrets
— (Array<map>
)The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
dependsOn
— (Array<map>
)The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
containerName
— required — (String
)The name of a container.
condition
— required — (String
)The dependency condition of the container. The following are the available conditions and their behavior:
-
START
- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. -
COMPLETE
- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. -
SUCCESS
- This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition can't be set on an essential container. -
HEALTHY
- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
"START"
"COMPLETE"
"SUCCESS"
"HEALTHY"
-
-
startTimeout
— (Integer
)Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE
,SUCCESS
, orHEALTHY
status. If astartTimeout
value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPED
state.Note: When theECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's enforced independently from this start timeout value.For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version
1.26.0
of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1
of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.The valid values for Fargate are 2-120 seconds.
-
stopTimeout
— (Integer
)Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the
stopTimeout
parameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUT
is used. If neither thestopTimeout
parameter or theECS_CONTAINER_STOP_TIMEOUT
agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.The valid values are 2-120 seconds.
-
hostname
— (String
)The hostname to use for your container. This parameter maps to
Hostname
in thethe docker conainer create command and the--hostname
option to docker run.Note: Thehostname
parameter is not supported if you're using theawsvpc
network mode.user
— (String
)The user to use inside the container. This parameter maps to
User
in the docker conainer create command and the--user
option to docker run.When running tasks using the
host
network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.You can specify the
user
using the following formats. If specifying a UID or GID, you must specify it as a positive integer.-
user
-
user:group
-
uid
-
uid:gid
-
user:gid
-
uid:group
Note: This parameter is not supported for Windows containers.-
workingDirectory
— (String
)The working directory to run commands inside the container in. This parameter maps to
WorkingDir
in the docker conainer create command and the--workdir
option to docker run.disableNetworking
— (Boolean
)When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the docker conainer create command.Note: This parameter is not supported for Windows containers.privileged
— (Boolean
)When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
root
user). This parameter maps toPrivileged
in the the docker conainer create command and the--privileged
option to docker runNote: This parameter is not supported for Windows containers or tasks run on Fargate.readonlyRootFilesystem
— (Boolean
)When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the docker conainer create command and the--read-only
option to docker run.Note: This parameter is not supported for Windows containers.dnsServers
— (Array<String>
)A list of DNS servers that are presented to the container. This parameter maps to
Dns
in the the docker conainer create command and the--dns
option to docker run.Note: This parameter is not supported for Windows containers.dnsSearchDomains
— (Array<String>
)A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the docker conainer create command and the--dns-search
option to docker run.Note: This parameter is not supported for Windows containers.extraHosts
— (Array<map>
)A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps toExtraHosts
in the docker conainer create command and the--add-host
option to docker run.Note: This parameter isn't supported for Windows containers or tasks that use theawsvpc
network mode.hostname
— required — (String
)The hostname to use in the
/etc/hosts
entry.ipAddress
— required — (String
)The IP address to use in the
/etc/hosts
entry.
dockerSecurityOptions
— (Array<String>
)A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to
SecurityOpt
in the docker conainer create command and the--security-opt
option to docker run.Note: The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=true
orECS_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 Elastic Container Service Developer Guide.Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
interactive
— (Boolean
)When this parameter is
true
, you can deploy containerized applications that requirestdin
or atty
to be allocated. This parameter maps toOpenStdin
in the docker conainer create command and the--interactive
option to docker run.pseudoTerminal
— (Boolean
)When this parameter is
true
, a TTY is allocated. This parameter maps toTty
in tthe docker conainer create command and the--tty
option to docker run.dockerLabels
— (map<String>
)A key/value map of labels to add to the container. This parameter maps to
Labels
in the docker conainer create command 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 in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
ulimits
— (Array<map>
)A list of
ulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
in tthe docker conainer create command and the--ulimit
option to docker run. Valid naming values are displayed in the Ulimit data type.Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the
nofile
resource limit parameter which Fargate overrides. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is65535
and the default hard limit is65535
.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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Note: This parameter is not supported for Windows containers.name
— required — (String
)The
Possible values include:type
of theulimit
."core"
"cpu"
"data"
"fsize"
"locks"
"memlock"
"msgqueue"
"nice"
"nofile"
"nproc"
"rss"
"rtprio"
"rttime"
"sigpending"
"stack"
softLimit
— required — (Integer
)The soft limit for the
ulimit
type.hardLimit
— required — (Integer
)The hard limit for the
ulimit
type.
logConfiguration
— (map
)The log configuration specification for the container.
This parameter maps to
LogConfig
in the docker conainer create command and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can 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).Note: Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional 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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_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 Elastic Container Service Developer Guide.logDriver
— required — (String
)The log driver to use for the container.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.Possible values include:"json-file"
"syslog"
"journald"
"gelf"
"fluentd"
"awslogs"
"splunk"
"awsfirelens"
options
— (map<String>
)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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
secretOptions
— (Array<map>
)The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
healthCheck
— (map
)The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheck
in the docker conainer create command and theHEALTHCHECK
parameter of docker run.command
— required — (Array<String>
)A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMD
to run the command arguments directly, orCMD-SHELL
to run the command with the container's default shell.When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
CMD-SHELL, curl -f http://localhost/ || exit 1
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see
HealthCheck
in tthe docker conainer create commandinterval
— (Integer
)The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
timeout
— (Integer
)The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
retries
— (Integer
)The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
startPeriod
— (Integer
)The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriod
is off.Note: If a health check succeeds within thestartPeriod
, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
systemControls
— (Array<map>
)A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctls
in tthe docker conainer create command and the--sysctl
option to docker run. For example, you can configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.namespace
— (String
)The namespaced kernel parameter to set a
value
for.value
— (String
)The namespaced kernel parameter to set a
value
for.Valid IPC namespace values:
"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"
, andSysctls
that start with"fs.mqueue.*"
Valid network namespace values:
Sysctls
that start with"net.*"
All of these values are supported by Fargate.
resourceRequirements
— (Array<map>
)The type and amount of a resource to assign to a container. The only supported resource is a GPU.
value
— required — (String
)The value for the specified resource type.
When the type is
GPU
, the value is the number of physicalGPUs
the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.When the type is
InferenceAccelerator
, thevalue
matches thedeviceName
for an InferenceAccelerator specified in a task definition.type
— required — (String
)The type of resource to assign to a container.
Possible values include:"GPU"
"InferenceAccelerator"
firelensConfiguration
— (map
)The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
type
— required — (String
)The log router to use. The valid values are
Possible values include:fluentd
orfluentbit
."fluentd"
"fluentbit"
options
— (map<String>
)The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.Note: Tasks hosted on Fargate only support thefile
configuration file type.
credentialSpecs
— (Array<String>
)A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec
) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
with an additional section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
for a single domain.You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace
MyARN
with the ARN in SSM or Amazon S3.If you provide a
credentialspecdomainless:MyARN
, thecredspec
must provide a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers.
family
— (String
)The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
taskRoleArn
— (String
)The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
executionRoleArn
— (String
)The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
networkMode
— (String
)The Docker networking mode to use for the containers in the task. The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.For Amazon ECS tasks on Fargate, the
awsvpc
network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,<default>
orawsvpc
can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.When using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.If the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.If the network mode is
Possible values include:host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used."bridge"
"host"
"awsvpc"
"none"
revision
— (Integer
)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 that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.volumes
— (Array<map>
)The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
Note: Thehost
andsourcePath
parameters aren't supported for tasks run on Fargate.name
— (String
)The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
When using a volume configured at launch, the
name
is required and must also be specified as the volume name in theServiceVolumeConfiguration
orTaskVolumeConfiguration
parameter when creating your service or standalone task.For all other types of volumes, this name is referenced in the
sourceVolume
parameter of themountPoints
object in the container definition.When a volume is using the
efsVolumeConfiguration
, the name is required.host
— (map
)This parameter is specified when you use bind mount host volumes. The contents of the
host
parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehost
parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\path
andD::D:\
, but notD:\my\path:C:\my\path
orD::C:\my\path
.sourcePath
— (String
)When the
host
parameter is used, specify asourcePath
to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehost
parameter contains asourcePath
file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePath
value doesn't 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.If you're using the Fargate launch type, the
sourcePath
parameter is not supported.
dockerVolumeConfiguration
— (map
)This parameter is specified when you use Docker volumes.
Windows containers only support the use of the
local
driver. To use bind mounts, specify thehost
parameter instead.Note: Docker volumes aren't supported by tasks run on Fargate.scope
— (String
)The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
Possible values include:task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops."task"
"shared"
autoprovision
— (Boolean
)If this value is
true
, the Docker volume is created if it doesn't already exist.Note: This field is only used if thescope
isshared
.driver
— (String
)The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps toDriver
in the docker conainer create command and thexxdriver
option to docker volume create.driverOpts
— (map<String>
)A map of Docker driver-specific options passed through. This parameter maps to
DriverOpts
in the docker create-volume command and thexxopt
option to docker volume create.labels
— (map<String>
)Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the docker conainer create command and thexxlabel
option to docker volume create.
efsVolumeConfiguration
— (map
)This parameter is specified when you use an Amazon Elastic File System file system for task storage.
fileSystemId
— required — (String
)The Amazon EFS file system ID to use.
rootDirectory
— (String
)The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/
will have the same effect as omitting this parameter.If an EFS access point is specified in the
authorizationConfig
, the root directory parameter must either be omitted or set to/
which will enforce the path set on the EFS access point.transitEncryption
— (String
)Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
Possible values include:DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide."ENABLED"
"DISABLED"
transitEncryptionPort
— (Integer
)The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
authorizationConfig
— (map
)The authorization configuration details for the Amazon EFS file system.
accessPointId
— (String
)The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfiguration
must either be omitted or set to/
which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration
. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.iam
— (String
)Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
Possible values include:EFSVolumeConfiguration
. If this parameter is omitted, the default value ofDISABLED
is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide."ENABLED"
"DISABLED"
fsxWindowsFileServerVolumeConfiguration
— (map
)This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
fileSystemId
— required — (String
)The Amazon FSx for Windows File Server file system ID to use.
rootDirectory
— required — (String
)The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
authorizationConfig
— required — (map
)The authorization configuration details for the Amazon FSx for Windows File Server file system.
credentialsParameter
— required — (String
)The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.
domain
— required — (String
)A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
configuredAtLaunch
— (Boolean
)Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurations
object when calling theCreateService
,UpdateService
,RunTask
orStartTask
APIs.
status
— (String
)The status of the task definition.
Possible values include:"ACTIVE"
"INACTIVE"
"DELETE_IN_PROGRESS"
requiresAttributes
— (Array<map>
)The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
Note: This parameter isn't supported for tasks run on Fargate.name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
placementConstraints
— (Array<map>
)An array of placement constraint objects to use for tasks.
Note: This parameter isn't supported for tasks run on Fargate.type
— (String
)The type of constraint. The
Possible values include:MemberOf
constraint restricts selection to be from a group of valid candidates."memberOf"
expression
— (String
)A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
compatibilities
— (Array<String>
)The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
runtimePlatform
— (map
)The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the
runtimePlatform
value of the service.cpuArchitecture
— (String
)The CPU architecture.
You can run your Linux tasks on an ARM-based platform by setting the value to
Possible values include:ARM64
. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate."X86_64"
"ARM64"
operatingSystemFamily
— (String
)The operating system.
Possible values include:"WINDOWS_SERVER_2019_FULL"
"WINDOWS_SERVER_2019_CORE"
"WINDOWS_SERVER_2016_FULL"
"WINDOWS_SERVER_2004_CORE"
"WINDOWS_SERVER_2022_CORE"
"WINDOWS_SERVER_2022_FULL"
"WINDOWS_SERVER_20H2_CORE"
"LINUX"
requiresCompatibilities
— (Array<String>
)The task launch types the task definition was validated against. The valid values are
EC2
,FARGATE
, andEXTERNAL
. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.cpu
— (String
)The number of
cpu
units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for thememory
parameter.If you use the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
-
256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) -
512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) -
1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) -
2048 (2 vCPU) - Available
memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
4096 (4 vCPU) - Available
memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
8192 (8 vCPU) - Available
memory
values: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0
or later. -
16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0
or later.
-
memory
— (String
)The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpu
parameter.-
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) -
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) -
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) -
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpu
values: 2048 (2 vCPU) -
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpu
values: 4096 (4 vCPU) -
Between 16 GB and 60 GB in 4 GB increments - Available
cpu
values: 8192 (8 vCPU)This option requires Linux platform
1.4.0
or later. -
Between 32GB and 120 GB in 8 GB increments - Available
cpu
values: 16384 (16 vCPU)This option requires Linux platform
1.4.0
or later.
-
inferenceAccelerators
— (Array<map>
)The Elastic Inference accelerator that's associated with the task.
deviceName
— required — (String
)The Elastic Inference accelerator device name. The
deviceName
must also be referenced in a container definition as a ResourceRequirement.deviceType
— required — (String
)The Elastic Inference accelerator type to use.
pidMode
— (String
)The process namespace to use for the containers in the task. The valid values are
host
ortask
. On Fargate for Linux containers, the only valid value istask
. For example, monitoring sidecars might needpidMode
to access information about other containers running in the same task.If
host
is specified, all containers within the tasks that specified thehost
PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.If
task
is specified, all containers within the specified task share the same process namespace.If no value is specified, the default is a private namespace for each container.
If the
host
PID mode is used, there's a heightened risk of undesired process namespace exposure.Note: This parameter is not supported for Windows containers.Note: This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform versionPossible values include:1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate."host"
"task"
ipcMode
— (String
)The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then all containers within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.If you are setting namespaced kernel parameters using
systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.-
For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported. -
For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
Note: This parameter is not supported for Windows containers or tasks run on Fargate.Possible values include:"host"
"task"
"none"
-
proxyConfiguration
— (map
)The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.type
— (String
)The proxy type. The only supported value is
Possible values include:APPMESH
."APPMESH"
containerName
— required — (String
)The name of the container that will serve as the App Mesh proxy.
properties
— (Array<map>
)The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
-
IgnoredUID
- (Required) The user ID (UID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGID
is specified, this field can be empty. -
IgnoredGID
- (Required) The group ID (GID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUID
is specified, this field can be empty. -
AppPorts
- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPort
andProxyEgressPort
. -
ProxyIngressPort
- (Required) Specifies the port that incoming traffic to theAppPorts
is directed to. -
ProxyEgressPort
- (Required) Specifies the port that outgoing traffic from theAppPorts
is directed to. -
EgressIgnoredPorts
- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort
. It can be an empty list. -
EgressIgnoredIPs
- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort
. It can be an empty list.
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
-
registeredAt
— (Date
)The Unix timestamp for the time when the task definition was registered.
deregisteredAt
— (Date
)The Unix timestamp for the time when the task definition was deregistered.
registeredBy
— (String
)The principal that registered the task definition.
ephemeralStorage
— (map
)The ephemeral storage settings to use for tasks run with the task definition.
sizeInGiB
— required — (Integer
)The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
20
GiB and the maximum supported value is200
GiB.
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
-
(AWS.Response)
—
Returns:
deleteTaskSet(params = {}, callback) ⇒ AWS.Request
Deletes a specified task set within a service. This is used when a service uses the
EXTERNAL
deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.Service Reference:
Examples:
Calling the deleteTaskSet operation
var params = { cluster: 'STRING_VALUE', /* required */ service: 'STRING_VALUE', /* required */ taskSet: 'STRING_VALUE', /* required */ force: true || false }; ecs.deleteTaskSet(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.
service
— (String
)The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
taskSet
— (String
)The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
force
— (Boolean
)If
true
, you can delete a task set even if it hasn't been scaled down to zero.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:taskSet
— (map
)Details about the task set.
id
— (String
)The ID of the task set.
taskSetArn
— (String
)The Amazon Resource Name (ARN) of the task set.
serviceArn
— (String
)The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy
— (String
)The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
startedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.externalId
— (String
)The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.status
— (String
)The status of the task set. The following describes each state.
- PRIMARY
-
The task set is serving production traffic.
- ACTIVE
-
The task set isn't serving production traffic.
- DRAINING
-
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
taskDefinition
— (String
)The task definition that the task set is using.
computedDesiredCount
— (Integer
)The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.pendingCount
— (Integer
)The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.runningCount
— (Integer
)The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.createdAt
— (Date
)The Unix timestamp for the time when the task set was created.
updatedAt
— (Date
)The Unix timestamp for the time when the task set was last updated.
launchType
— (String
)The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that are associated with the task set.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
platformFamily
— (String
)The 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.
All tasks in the set must have the same value.
networkConfiguration
— (map
)The network configuration for the task set.
awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
loadBalancers
— (Array<map>
)Details on a load balancer that are used with a task set.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
scale
— (map
)A floating-point percentage of your desired number of tasks to place and keep running in the task set.
value
— (Float
)The value, specified as a percent total of a service's
desiredCount
, to scale the task set. Accepted values are numbers between 0 and 100.unit
— (String
)The unit of measure for the scale value.
Possible values include:"PERCENT"
stabilityStatus
— (String
)The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are running on container instances in the
DRAINING
status. -
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
Possible values include:STABILIZING
."STEADY_STATE"
"STABILIZING"
-
stabilityStatusAt
— (Date
)The Unix timestamp for the time when the task set stability status was retrieved.
tags
— (Array<map>
)The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the task set.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
-
(AWS.Response)
—
Returns:
deregisterContainerInstance(params = {}, callback) ⇒ AWS.Request
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
Note: If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).Service Reference:
Examples:
To deregister a container instance from a cluster
/* This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option. */ var params = { cluster: "default", containerInstance: "container_instance_UUID", force: true }; ecs.deregisterContainerInstance(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { } */ });
Calling the deregisterContainerInstance operation
var params = { containerInstance: 'STRING_VALUE', /* required */ cluster: 'STRING_VALUE', force: true || false }; ecs.deregisterContainerInstance(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)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.
containerInstance
— (String
)The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
force
— (Boolean
)Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the
force
option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they're 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.Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:containerInstance
— (map
)The container instance that was deregistered.
containerInstanceArn
— (String
)The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
ec2InstanceId
— (String
)The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
capacityProviderName
— (String
)The capacity provider that's associated with the container instance.
version
— (Integer
)The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the
detail
object) to verify that the version in your event stream is current.versionInfo
— (map
)The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
agentVersion
— (String
)The version number of the Amazon ECS container agent.
agentHash
— (String
)The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
dockerVersion
— (String
)The Docker version that's running on the container instance.
remainingResources
— (Array<map>
)For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the
host
orbridge
network mode). Any port that's not specified here is available for new tasks.name
— (String
)The name of the resource, such as
CPU
,MEMORY
,PORTS
,PORTS_UDP
, or a user-defined resource.type
— (String
)The type of the resource. Valid values:
INTEGER
,DOUBLE
,LONG
, orSTRINGSET
.doubleValue
— (Float
)When the
doubleValue
type is set, the value of the resource must be a double precision floating-point type.longValue
— (Integer
)When the
longValue
type is set, the value of the resource must be an extended precision floating-point type.integerValue
— (Integer
)When the
integerValue
type is set, the value of the resource must be an integer.stringSetValue
— (Array<String>
)When the
stringSetValue
type is set, the value of the resource must be a string type.
registeredResources
— (Array<map>
)For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
name
— (String
)The name of the resource, such as
CPU
,MEMORY
,PORTS
,PORTS_UDP
, or a user-defined resource.type
— (String
)The type of the resource. Valid values:
INTEGER
,DOUBLE
,LONG
, orSTRINGSET
.doubleValue
— (Float
)When the
doubleValue
type is set, the value of the resource must be a double precision floating-point type.longValue
— (Integer
)When the
longValue
type is set, the value of the resource must be an extended precision floating-point type.integerValue
— (Integer
)When the
integerValue
type is set, the value of the resource must be an integer.stringSetValue
— (Array<String>
)When the
stringSetValue
type is set, the value of the resource must be a string type.
status
— (String
)The status of the container instance. The valid values are
REGISTERING
,REGISTRATION_FAILED
,ACTIVE
,INACTIVE
,DEREGISTERING
, orDRAINING
.If your account has opted in to the
awsvpcTrunking
account setting, then any newly registered container instance will transition to aREGISTERING
status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to aREGISTRATION_FAILED
status. You can describe the container instance and see the reason for failure in thestatusReason
parameter. Once the container instance is terminated, the instance transitions to aDEREGISTERING
status while the trunk elastic network interface is deprovisioned. The instance then transitions to anINACTIVE
status.The
ACTIVE
status indicates that the container instance can accept tasks. TheDRAINING
indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.statusReason
— (String
)The reason that the container instance reached its current status.
agentConnected
— (Boolean
)This parameter returns
true
if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped returnfalse
. Only instances connected to an agent can accept task placement requests.runningTasksCount
— (Integer
)The number of tasks on the container instance that have a desired status (
desiredStatus
) ofRUNNING
.pendingTasksCount
— (Integer
)The number of tasks on the container instance that are in the
PENDING
status.agentUpdateStatus
— (String
)The status of the most recent agent update. If an update wasn't ever requested, this value is
Possible values include:NULL
."PENDING"
"STAGING"
"STAGED"
"UPDATING"
"UPDATED"
"FAILED"
attributes
— (Array<map>
)The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
registeredAt
— (Date
)The Unix timestamp for the time when the container instance was registered.
attachments
— (Array<map>
)The resources attached to a container instance, such as an elastic network interface.
id
— (String
)The unique identifier for the attachment.
type
— (String
)The type of the attachment, such as
ElasticNetworkInterface
,Service Connect
, andAmazonElasticBlockStorage
.status
— (String
)The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
,DELETED
, andFAILED
.details
— (Array<map>
)Details of the attachment.
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
For Service Connect services, this includes
portName
,clientAliases
,discoveryName
, andingressPortOverride
.For Elastic Block Storage, this includes
roleArn
,deleteOnTermination
,volumeName
,volumeId
, andstatusReason
(only when the attachment fails to create or attach).name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags
— (Array<map>
)The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
healthStatus
— (map
)An object representing the health status of the container instance.
overallStatus
— (String
)The overall health status of the container instance. This is an aggregate status of all container instance health checks.
Possible values include:"OK"
"IMPAIRED"
"INSUFFICIENT_DATA"
"INITIALIZING"
details
— (Array<map>
)An array of objects representing the details of the container instance health status.
type
— (String
)The type of container instance health status that was verified.
Possible values include:"CONTAINER_RUNTIME"
status
— (String
)The container instance health status.
Possible values include:"OK"
"IMPAIRED"
"INSUFFICIENT_DATA"
"INITIALIZING"
lastUpdated
— (Date
)The Unix timestamp for when the container instance health status was last updated.
lastStatusChange
— (Date
)The Unix timestamp for when the container instance health status last changed.
-
(AWS.Response)
—
Returns:
deregisterTaskDefinition(params = {}, callback) ⇒ AWS.Request
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as
INACTIVE
. Existing tasks and services that reference anINACTIVE
task definition continue to run without disruption. Existing services that reference anINACTIVE
task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.You can't use an
INACTIVE
task definition to run new tasks or create new services, and you can't update an existing service to reference anINACTIVE
task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.Note: At this time,INACTIVE
task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVE
task definitions persisting beyond the lifecycle of any associated tasks and services.You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.
Service Reference:
Examples:
Calling the deregisterTaskDefinition operation
var params = { taskDefinition: 'STRING_VALUE' /* required */ }; ecs.deregisterTaskDefinition(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
taskDefinition
— (String
)The
family
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify arevision
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:taskDefinition
— (map
)The full description of the deregistered task.
taskDefinitionArn
— (String
)The full Amazon Resource Name (ARN) of the task definition.
containerDefinitions
— (Array<map>
)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 Elastic Container Service Developer Guide.
name
— (String
)The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in thelinks
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps toname
in tthe docker conainer create command and the--name
option to docker run.image
— (String
)The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
orrepository-url/image@digest
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImage
in the docker conainer create command and theIMAGE
parameter of docker run.-
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
-
Images in Amazon ECR repositories can be specified by either using the full
registry/repository:tag
orregistry/repository@digest
. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
. -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
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
).
-
repositoryCredentials
— (map
)The private repository authentication credentials to use.
credentialsParameter
— required — (String
)The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Note: When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
cpu
— (Integer
)The number of
cpu
units reserved for the container. This parameter maps toCpuShares
in the docker conainer create commandand the--cpu-shares
option to docker run.This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level
cpu
value.Note: 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.Linux containers share unallocated CPU units with other containers on the container 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, 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 two 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.
-
Agent versions greater than or equal to 1.84.0: CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as
0
, which Windows interprets as 1% of one CPU.-
memory
— (Integer
)The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memory
value, if one is specified. This parameter maps toMemory
in thethe docker conainer create command and the--memory
option to docker run.If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level
memory
andmemoryReservation
value,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
is used.The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memoryReservation
— (Integer
)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 toMemoryReservation
in the the docker conainer create command and the--memory-reservation
option to docker run.If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
ormemoryReservation
in a container definition. If you specify both,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
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 amemory
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.The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
links
— (Array<String>
)The
links
parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge
. Thename:internalName
construct is analogous toname:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps toLinks
in the docker conainer create command and the--link
option to docker run.Note: This parameter is not supported for Windows containers.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.
portMappings
— (Array<map>
)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.
For task definitions that use the
awsvpc
network mode, only specify thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.This parameter maps to
PortBindings
in the the docker conainer create command and the--publish
option to docker run. If the network mode of a task definition is set tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, then host ports must either be undefined or they must match the container port in the port mapping.Note: After a task reaches theRUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindings
section DescribeTasks responses.containerPort
— (Integer
)The port number on the container that's bound to the user-specified or automatically assigned host port.
If you use containers in a task with the
awsvpc
orhost
network mode, specify the exposed ports usingcontainerPort
.If you use containers in a task with the
bridge
network mode and 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, seehostPort
. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.hostPort
— (Integer
)The port number on the container instance to reserve for your container.
If you specify a
containerPortRange
, leave this field empty and the value of thehostPort
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPort
is set to the same value as thecontainerPort
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.
If you use containers in a task with the
awsvpc
orhost
network mode, thehostPort
can either be left blank or set to the same value as thecontainerPort
.If you use containers in a task with the
bridge
network mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort
(or set it to0
) while specifying acontainerPort
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 for Docker version 1.6.0 and later is listed on the instance under
/proc/sys/net/ipv4/ip_local_port_range
. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as 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 ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.-
protocol
— (String
)The protocol used for the port mapping. Valid values are
Possible values include:tcp
andudp
. The default istcp
.protocol
is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment."tcp"
"udp"
name
— (String
)The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfiguration
of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
appProtocol
— (String
)The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocol
is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
Possible values include:"http"
"http2"
"grpc"
containerPortRange
— (String
)The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a
containerPortRange
:-
You must use either the
bridge
network mode or theawsvpc
network mode. -
This parameter is available for both the EC2 and Fargate launch types.
-
This parameter is available for both the Linux and Windows operating systems.
-
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the
ecs-init
package -
You can specify a maximum of 100 port ranges per container.
-
You do not specify a
hostPortRange
. The value of thehostPortRange
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPortRange
is set to the same value as thecontainerPortRange
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
-
-
The
containerPortRange
valid values are between 1 and 65535. -
A port can only be included in one port mapping per container.
-
You cannot specify overlapping port ranges.
-
The first port in the range must be less than last port in the range.
-
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view thehostPortRange
which are the host ports that are bound to the container ports.-
essential
— (Boolean
)If the
essential
parameter of a container is marked astrue
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessential
parameter of a container is marked asfalse
, its failure doesn't 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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
restartPolicy
— (map
)The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
enabled
— required — (Boolean
)Specifies whether a restart policy is enabled for the container.
ignoredExitCodes
— (Array<Integer>
)A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.
restartAttemptPeriod
— (Integer
)A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every
restartAttemptPeriod
seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimumrestartAttemptPeriod
of 60 seconds and a maximumrestartAttemptPeriod
of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.
entryPoint
— (Array<String>
)Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
array items instead.The entry point that's passed to the container. This parameter maps to
Entrypoint
in tthe docker conainer create command and the--entrypoint
option to docker run.command
— (Array<String>
)The command that's passed to the container. This parameter maps to
Cmd
in the docker conainer create command and theCOMMAND
parameter to docker run. If there are multiple arguments, each argument is a separated string in the array.environment
— (Array<map>
)The environment variables to pass to a container. This parameter maps to
Env
in the docker conainer create command and the--env
option to docker run.We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
environmentFiles
— (Array<map>
)A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.You can specify up to ten environment files. The file must have a
.env
file extension. Each line in an environment file contains an environment variable inVARIABLE=VALUE
format. Lines beginning with#
are treated as comments and are ignored.If there are environment variables specified using the
environment
parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.value
— required — (String
)The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type
— required — (String
)The file type to use. Environment files are objects in Amazon S3. The only supported value is
Possible values include:s3
."s3"
mountPoints
— (Array<map>
)The mount points for data volumes in your container.
This parameter maps to
Volumes
in the the docker conainer create command and the--volume
option to docker run.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives.sourceVolume
— (String
)The name of the volume to mount. Must be a volume name referenced in the
name
parameter of task definitionvolume
.containerPath
— (String
)The path on the container to mount the host volume at.
readOnly
— (Boolean
)If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
volumesFrom
— (Array<map>
)Data volumes to mount from another container. This parameter maps to
VolumesFrom
in tthe docker conainer create command and the--volumes-from
option to docker run.sourceContainer
— (String
)The name of another container within the same task definition to mount volumes from.
readOnly
— (Boolean
)If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
linuxParameters
— (map
)Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
Note: This parameter is not supported for Windows containers.capabilities
— (map
)The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note: For tasks that use the Fargate launch type,capabilities
is supported for all platform versions but theadd
parameter is only supported if using platform version 1.4.0 or later.add
— (Array<String>
)The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAdd
in the docker conainer create command and the--cap-add
option to docker run.Note: Tasks launched on Fargate only support adding theSYS_PTRACE
kernel capability.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
drop
— (Array<String>
)The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDrop
in the docker conainer create command and the--cap-drop
option to docker run.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
devices
— (Array<map>
)Any host devices to expose to the container. This parameter maps to
Devices
in tthe docker conainer create command and the--device
option to docker run.Note: If you're using tasks that use the Fargate launch type, thedevices
parameter isn't supported.hostPath
— required — (String
)The path for the device on the host container instance.
containerPath
— (String
)The path inside the container at which to expose the host device.
permissions
— (Array<String>
)The explicit permissions to provide to the container for the device. By default, the container has permissions for
read
,write
, andmknod
for the device.
initProcessEnabled
— (Boolean
)Run an
init
process inside the container that forwards signals and reaps processes. This parameter maps to the--init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
sharedMemorySize
— (Integer
)The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run.Note: If you are using tasks that use the Fargate launch type, thesharedMemorySize
parameter is not supported.tmpfs
— (Array<map>
)The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run.Note: If you're using tasks that use the Fargate launch type, thetmpfs
parameter isn't supported.containerPath
— required — (String
)The absolute file path where the tmpfs volume is to be mounted.
size
— required — (Integer
)The maximum size (in MiB) of the tmpfs volume.
mountOptions
— (Array<String>
)The list of tmpfs volume mount options.
Valid values:
"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
maxSwap
— (Integer
)The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swap
option to docker run where the value would be the sum of the container memory plus themaxSwap
value.If a
maxSwap
value of0
is specified, the container will not use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
parameter to be used.Note: If you're using tasks that use the Fargate launch type, themaxSwap
parameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappiness
parameter isn't supported.swappiness
— (Integer
)This allows you to tune a container's memory swappiness behavior. A
swappiness
value of0
will cause swapping to not happen unless absolutely necessary. Aswappiness
value of100
will cause pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter is not specified, a default value of60
is used. If a value is not specified formaxSwap
then this parameter is ignored. This parameter maps to the--memory-swappiness
option to docker run.Note: If you're using tasks that use the Fargate launch type, theswappiness
parameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappiness
parameter isn't supported.
secrets
— (Array<map>
)The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
dependsOn
— (Array<map>
)The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
containerName
— required — (String
)The name of a container.
condition
— required — (String
)The dependency condition of the container. The following are the available conditions and their behavior:
-
START
- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. -
COMPLETE
- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. -
SUCCESS
- This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition can't be set on an essential container. -
HEALTHY
- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
"START"
"COMPLETE"
"SUCCESS"
"HEALTHY"
-
-
startTimeout
— (Integer
)Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE
,SUCCESS
, orHEALTHY
status. If astartTimeout
value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPED
state.Note: When theECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's enforced independently from this start timeout value.For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version
1.26.0
of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1
of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.The valid values for Fargate are 2-120 seconds.
-
stopTimeout
— (Integer
)Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the
stopTimeout
parameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUT
is used. If neither thestopTimeout
parameter or theECS_CONTAINER_STOP_TIMEOUT
agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.The valid values are 2-120 seconds.
-
hostname
— (String
)The hostname to use for your container. This parameter maps to
Hostname
in thethe docker conainer create command and the--hostname
option to docker run.Note: Thehostname
parameter is not supported if you're using theawsvpc
network mode.user
— (String
)The user to use inside the container. This parameter maps to
User
in the docker conainer create command and the--user
option to docker run.When running tasks using the
host
network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.You can specify the
user
using the following formats. If specifying a UID or GID, you must specify it as a positive integer.-
user
-
user:group
-
uid
-
uid:gid
-
user:gid
-
uid:group
Note: This parameter is not supported for Windows containers.-
workingDirectory
— (String
)The working directory to run commands inside the container in. This parameter maps to
WorkingDir
in the docker conainer create command and the--workdir
option to docker run.disableNetworking
— (Boolean
)When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the docker conainer create command.Note: This parameter is not supported for Windows containers.privileged
— (Boolean
)When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
root
user). This parameter maps toPrivileged
in the the docker conainer create command and the--privileged
option to docker runNote: This parameter is not supported for Windows containers or tasks run on Fargate.readonlyRootFilesystem
— (Boolean
)When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the docker conainer create command and the--read-only
option to docker run.Note: This parameter is not supported for Windows containers.dnsServers
— (Array<String>
)A list of DNS servers that are presented to the container. This parameter maps to
Dns
in the the docker conainer create command and the--dns
option to docker run.Note: This parameter is not supported for Windows containers.dnsSearchDomains
— (Array<String>
)A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the docker conainer create command and the--dns-search
option to docker run.Note: This parameter is not supported for Windows containers.extraHosts
— (Array<map>
)A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps toExtraHosts
in the docker conainer create command and the--add-host
option to docker run.Note: This parameter isn't supported for Windows containers or tasks that use theawsvpc
network mode.hostname
— required — (String
)The hostname to use in the
/etc/hosts
entry.ipAddress
— required — (String
)The IP address to use in the
/etc/hosts
entry.
dockerSecurityOptions
— (Array<String>
)A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to
SecurityOpt
in the docker conainer create command and the--security-opt
option to docker run.Note: The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=true
orECS_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 Elastic Container Service Developer Guide.Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
interactive
— (Boolean
)When this parameter is
true
, you can deploy containerized applications that requirestdin
or atty
to be allocated. This parameter maps toOpenStdin
in the docker conainer create command and the--interactive
option to docker run.pseudoTerminal
— (Boolean
)When this parameter is
true
, a TTY is allocated. This parameter maps toTty
in tthe docker conainer create command and the--tty
option to docker run.dockerLabels
— (map<String>
)A key/value map of labels to add to the container. This parameter maps to
Labels
in the docker conainer create command 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 in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
ulimits
— (Array<map>
)A list of
ulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
in tthe docker conainer create command and the--ulimit
option to docker run. Valid naming values are displayed in the Ulimit data type.Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the
nofile
resource limit parameter which Fargate overrides. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is65535
and the default hard limit is65535
.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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Note: This parameter is not supported for Windows containers.name
— required — (String
)The
Possible values include:type
of theulimit
."core"
"cpu"
"data"
"fsize"
"locks"
"memlock"
"msgqueue"
"nice"
"nofile"
"nproc"
"rss"
"rtprio"
"rttime"
"sigpending"
"stack"
softLimit
— required — (Integer
)The soft limit for the
ulimit
type.hardLimit
— required — (Integer
)The hard limit for the
ulimit
type.
logConfiguration
— (map
)The log configuration specification for the container.
This parameter maps to
LogConfig
in the docker conainer create command and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can 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).Note: Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional 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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_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 Elastic Container Service Developer Guide.logDriver
— required — (String
)The log driver to use for the container.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.Possible values include:"json-file"
"syslog"
"journald"
"gelf"
"fluentd"
"awslogs"
"splunk"
"awsfirelens"
options
— (map<String>
)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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
secretOptions
— (Array<map>
)The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
healthCheck
— (map
)The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheck
in the docker conainer create command and theHEALTHCHECK
parameter of docker run.command
— required — (Array<String>
)A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMD
to run the command arguments directly, orCMD-SHELL
to run the command with the container's default shell.When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
CMD-SHELL, curl -f http://localhost/ || exit 1
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see
HealthCheck
in tthe docker conainer create commandinterval
— (Integer
)The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
timeout
— (Integer
)The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
retries
— (Integer
)The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
startPeriod
— (Integer
)The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriod
is off.Note: If a health check succeeds within thestartPeriod
, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
systemControls
— (Array<map>
)A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctls
in tthe docker conainer create command and the--sysctl
option to docker run. For example, you can configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.namespace
— (String
)The namespaced kernel parameter to set a
value
for.value
— (String
)The namespaced kernel parameter to set a
value
for.Valid IPC namespace values:
"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"
, andSysctls
that start with"fs.mqueue.*"
Valid network namespace values:
Sysctls
that start with"net.*"
All of these values are supported by Fargate.
resourceRequirements
— (Array<map>
)The type and amount of a resource to assign to a container. The only supported resource is a GPU.
value
— required — (String
)The value for the specified resource type.
When the type is
GPU
, the value is the number of physicalGPUs
the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.When the type is
InferenceAccelerator
, thevalue
matches thedeviceName
for an InferenceAccelerator specified in a task definition.type
— required — (String
)The type of resource to assign to a container.
Possible values include:"GPU"
"InferenceAccelerator"
firelensConfiguration
— (map
)The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
type
— required — (String
)The log router to use. The valid values are
Possible values include:fluentd
orfluentbit
."fluentd"
"fluentbit"
options
— (map<String>
)The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.Note: Tasks hosted on Fargate only support thefile
configuration file type.
credentialSpecs
— (Array<String>
)A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec
) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
with an additional section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
for a single domain.You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace
MyARN
with the ARN in SSM or Amazon S3.If you provide a
credentialspecdomainless:MyARN
, thecredspec
must provide a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers.
family
— (String
)The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
taskRoleArn
— (String
)The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
executionRoleArn
— (String
)The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
networkMode
— (String
)The Docker networking mode to use for the containers in the task. The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.For Amazon ECS tasks on Fargate, the
awsvpc
network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,<default>
orawsvpc
can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.When using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.If the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.If the network mode is
Possible values include:host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used."bridge"
"host"
"awsvpc"
"none"
revision
— (Integer
)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 that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.volumes
— (Array<map>
)The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
Note: Thehost
andsourcePath
parameters aren't supported for tasks run on Fargate.name
— (String
)The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
When using a volume configured at launch, the
name
is required and must also be specified as the volume name in theServiceVolumeConfiguration
orTaskVolumeConfiguration
parameter when creating your service or standalone task.For all other types of volumes, this name is referenced in the
sourceVolume
parameter of themountPoints
object in the container definition.When a volume is using the
efsVolumeConfiguration
, the name is required.host
— (map
)This parameter is specified when you use bind mount host volumes. The contents of the
host
parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehost
parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\path
andD::D:\
, but notD:\my\path:C:\my\path
orD::C:\my\path
.sourcePath
— (String
)When the
host
parameter is used, specify asourcePath
to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehost
parameter contains asourcePath
file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePath
value doesn't 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.If you're using the Fargate launch type, the
sourcePath
parameter is not supported.
dockerVolumeConfiguration
— (map
)This parameter is specified when you use Docker volumes.
Windows containers only support the use of the
local
driver. To use bind mounts, specify thehost
parameter instead.Note: Docker volumes aren't supported by tasks run on Fargate.scope
— (String
)The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
Possible values include:task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops."task"
"shared"
autoprovision
— (Boolean
)If this value is
true
, the Docker volume is created if it doesn't already exist.Note: This field is only used if thescope
isshared
.driver
— (String
)The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps toDriver
in the docker conainer create command and thexxdriver
option to docker volume create.driverOpts
— (map<String>
)A map of Docker driver-specific options passed through. This parameter maps to
DriverOpts
in the docker create-volume command and thexxopt
option to docker volume create.labels
— (map<String>
)Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the docker conainer create command and thexxlabel
option to docker volume create.
efsVolumeConfiguration
— (map
)This parameter is specified when you use an Amazon Elastic File System file system for task storage.
fileSystemId
— required — (String
)The Amazon EFS file system ID to use.
rootDirectory
— (String
)The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/
will have the same effect as omitting this parameter.If an EFS access point is specified in the
authorizationConfig
, the root directory parameter must either be omitted or set to/
which will enforce the path set on the EFS access point.transitEncryption
— (String
)Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
Possible values include:DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide."ENABLED"
"DISABLED"
transitEncryptionPort
— (Integer
)The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
authorizationConfig
— (map
)The authorization configuration details for the Amazon EFS file system.
accessPointId
— (String
)The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfiguration
must either be omitted or set to/
which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration
. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.iam
— (String
)Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
Possible values include:EFSVolumeConfiguration
. If this parameter is omitted, the default value ofDISABLED
is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide."ENABLED"
"DISABLED"
fsxWindowsFileServerVolumeConfiguration
— (map
)This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
fileSystemId
— required — (String
)The Amazon FSx for Windows File Server file system ID to use.
rootDirectory
— required — (String
)The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
authorizationConfig
— required — (map
)The authorization configuration details for the Amazon FSx for Windows File Server file system.
credentialsParameter
— required — (String
)The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.
domain
— required — (String
)A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
configuredAtLaunch
— (Boolean
)Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurations
object when calling theCreateService
,UpdateService
,RunTask
orStartTask
APIs.
status
— (String
)The status of the task definition.
Possible values include:"ACTIVE"
"INACTIVE"
"DELETE_IN_PROGRESS"
requiresAttributes
— (Array<map>
)The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
Note: This parameter isn't supported for tasks run on Fargate.name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
placementConstraints
— (Array<map>
)An array of placement constraint objects to use for tasks.
Note: This parameter isn't supported for tasks run on Fargate.type
— (String
)The type of constraint. The
Possible values include:MemberOf
constraint restricts selection to be from a group of valid candidates."memberOf"
expression
— (String
)A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
compatibilities
— (Array<String>
)The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
runtimePlatform
— (map
)The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the
runtimePlatform
value of the service.cpuArchitecture
— (String
)The CPU architecture.
You can run your Linux tasks on an ARM-based platform by setting the value to
Possible values include:ARM64
. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate."X86_64"
"ARM64"
operatingSystemFamily
— (String
)The operating system.
Possible values include:"WINDOWS_SERVER_2019_FULL"
"WINDOWS_SERVER_2019_CORE"
"WINDOWS_SERVER_2016_FULL"
"WINDOWS_SERVER_2004_CORE"
"WINDOWS_SERVER_2022_CORE"
"WINDOWS_SERVER_2022_FULL"
"WINDOWS_SERVER_20H2_CORE"
"LINUX"
requiresCompatibilities
— (Array<String>
)The task launch types the task definition was validated against. The valid values are
EC2
,FARGATE
, andEXTERNAL
. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.cpu
— (String
)The number of
cpu
units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for thememory
parameter.If you use the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
-
256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) -
512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) -
1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) -
2048 (2 vCPU) - Available
memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
4096 (4 vCPU) - Available
memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
8192 (8 vCPU) - Available
memory
values: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0
or later. -
16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0
or later.
-
memory
— (String
)The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpu
parameter.-
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) -
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) -
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) -
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpu
values: 2048 (2 vCPU) -
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpu
values: 4096 (4 vCPU) -
Between 16 GB and 60 GB in 4 GB increments - Available
cpu
values: 8192 (8 vCPU)This option requires Linux platform
1.4.0
or later. -
Between 32GB and 120 GB in 8 GB increments - Available
cpu
values: 16384 (16 vCPU)This option requires Linux platform
1.4.0
or later.
-
inferenceAccelerators
— (Array<map>
)The Elastic Inference accelerator that's associated with the task.
deviceName
— required — (String
)The Elastic Inference accelerator device name. The
deviceName
must also be referenced in a container definition as a ResourceRequirement.deviceType
— required — (String
)The Elastic Inference accelerator type to use.
pidMode
— (String
)The process namespace to use for the containers in the task. The valid values are
host
ortask
. On Fargate for Linux containers, the only valid value istask
. For example, monitoring sidecars might needpidMode
to access information about other containers running in the same task.If
host
is specified, all containers within the tasks that specified thehost
PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.If
task
is specified, all containers within the specified task share the same process namespace.If no value is specified, the default is a private namespace for each container.
If the
host
PID mode is used, there's a heightened risk of undesired process namespace exposure.Note: This parameter is not supported for Windows containers.Note: This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform versionPossible values include:1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate."host"
"task"
ipcMode
— (String
)The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then all containers within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.If you are setting namespaced kernel parameters using
systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.-
For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported. -
For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
Note: This parameter is not supported for Windows containers or tasks run on Fargate.Possible values include:"host"
"task"
"none"
-
proxyConfiguration
— (map
)The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.type
— (String
)The proxy type. The only supported value is
Possible values include:APPMESH
."APPMESH"
containerName
— required — (String
)The name of the container that will serve as the App Mesh proxy.
properties
— (Array<map>
)The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
-
IgnoredUID
- (Required) The user ID (UID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGID
is specified, this field can be empty. -
IgnoredGID
- (Required) The group ID (GID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUID
is specified, this field can be empty. -
AppPorts
- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPort
andProxyEgressPort
. -
ProxyIngressPort
- (Required) Specifies the port that incoming traffic to theAppPorts
is directed to. -
ProxyEgressPort
- (Required) Specifies the port that outgoing traffic from theAppPorts
is directed to. -
EgressIgnoredPorts
- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort
. It can be an empty list. -
EgressIgnoredIPs
- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort
. It can be an empty list.
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
-
registeredAt
— (Date
)The Unix timestamp for the time when the task definition was registered.
deregisteredAt
— (Date
)The Unix timestamp for the time when the task definition was deregistered.
registeredBy
— (String
)The principal that registered the task definition.
ephemeralStorage
— (map
)The ephemeral storage settings to use for tasks run with the task definition.
sizeInGiB
— required — (Integer
)The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
20
GiB and the maximum supported value is200
GiB.
-
(AWS.Response)
—
Returns:
describeCapacityProviders(params = {}, callback) ⇒ AWS.Request
Describes one or more of your capacity providers.
Service Reference:
Examples:
Calling the describeCapacityProviders operation
var params = { capacityProviders: [ 'STRING_VALUE', /* more items */ ], include: [ TAGS, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; ecs.describeCapacityProviders(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
capacityProviders
— (Array<String>
)The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to
100
capacity providers can be described in an action.include
— (Array<String>
)Specifies whether or not you want to see the resource tags for the capacity provider. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.maxResults
— (Integer
)The maximum number of account setting results returned by
DescribeCapacityProviders
in paginated output. When this parameter is used,DescribeCapacityProviders
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeCapacityProviders
request with the returnednextToken
value. This value can be between 1 and 10. If this parameter is not used, thenDescribeCapacityProviders
returns up to 10 results and anextToken
value if applicable.nextToken
— (String
)The
nextToken
value returned from a previous paginatedDescribeCapacityProviders
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.Note: 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.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:capacityProviders
— (Array<map>
)The list of capacity providers.
capacityProviderArn
— (String
)The Amazon Resource Name (ARN) that identifies the capacity provider.
name
— (String
)The name of the capacity provider.
status
— (String
)The current status of the capacity provider. Only capacity providers in an
Possible values include:ACTIVE
state can be used in a cluster. When a capacity provider is successfully deleted, it has anINACTIVE
status."ACTIVE"
"INACTIVE"
autoScalingGroupProvider
— (map
)The Auto Scaling group settings for the capacity provider.
autoScalingGroupArn
— required — (String
)The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
managedScaling
— (map
)The managed scaling settings for the Auto Scaling group capacity provider.
status
— (String
)Determines whether to use managed scaling for the capacity provider.
Possible values include:"ENABLED"
"DISABLED"
targetCapacity
— (Integer
)The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than
0
and less than or equal to100
. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use atargetCapacity
of90
. The default value of100
percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.minimumScalingStepSize
— (Integer
)The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of
1
is used.When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
maximumScalingStepSize
— (Integer
)The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of
10000
is used.instanceWarmupPeriod
— (Integer
)The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of
300
seconds is used.
managedTerminationProtection
— (String
)The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
Possible values include:"ENABLED"
"DISABLED"
managedDraining
— (String
)The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
Possible values include:"ENABLED"
"DISABLED"
updateStatus
— (String
)The update status of the capacity provider. The following are the possible states that is returned.
- DELETE_IN_PROGRESS
-
The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
-
The capacity provider was successfully deleted and has an
INACTIVE
status. - DELETE_FAILED
-
The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
"DELETE_IN_PROGRESS"
"DELETE_COMPLETE"
"DELETE_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_COMPLETE"
"UPDATE_FAILED"
updateStatusReason
— (String
)The update status reason. This provides further details about the update status for the capacity provider.
tags
— (Array<map>
)The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
nextToken
— (String
)The
nextToken
value to include in a futureDescribeCapacityProviders
request. When the results of aDescribeCapacityProviders
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
describeClusters(params = {}, callback) ⇒ AWS.Request
Describes one or more of your clusters.
Service Reference:
Examples:
To describe a cluster
/* This example provides a description of the specified cluster in your default region. */ var params = { clusters: [ "default" ] }; ecs.describeClusters(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { clusters: [ { clusterArn: "arn:aws:ecs:us-east-1:aws_account_id:cluster/default", clusterName: "default", status: "ACTIVE" } ], failures: [ ] } */ });
Calling the describeClusters operation
var params = { clusters: [ 'STRING_VALUE', /* more items */ ], include: [ ATTACHMENTS | CONFIGURATIONS | SETTINGS | STATISTICS | TAGS, /* more items */ ] }; ecs.describeClusters(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
clusters
— (Array<String>
)A 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.
include
— (Array<String>
)Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.
If
ATTACHMENTS
is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.If
SETTINGS
is specified, the settings for the cluster are included.If
CONFIGURATIONS
is specified, the configuration for the cluster is included.If
STATISTICS
is specified, the task and service count is included, separated by launch type.If
TAGS
is specified, the metadata tags associated with the cluster are included.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:clusters
— (Array<map>
)The list of clusters.
clusterArn
— (String
)The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
clusterName
— (String
)A user-generated string that you use to identify your cluster.
configuration
— (map
)The execute command configuration for the cluster.
executeCommandConfiguration
— (map
)The details of the execute command configuration.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the data between the local client and the container.
logging
— (String
)The log setting to use for redirecting logs for your execute command results. The following log settings are available.
-
NONE
: The execute command session is not logged. -
DEFAULT
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged. -
OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.
"NONE"
"DEFAULT"
"OVERRIDE"
-
logConfiguration
— (map
)The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE
is specified, alogConfiguration
must be provided.cloudWatchLogGroupName
— (String
)The name of the CloudWatch log group to send logs to.
Note: The CloudWatch log group must already be created.cloudWatchEncryptionEnabled
— (Boolean
)Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
s3BucketName
— (String
)The name of the S3 bucket to send logs to.
Note: The S3 bucket must already be created.s3EncryptionEnabled
— (Boolean
)Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
s3KeyPrefix
— (String
)An optional folder in the S3 bucket to place logs in.
managedStorageConfiguration
— (map
)The details of the managed storage configuration.
kmsKeyId
— (String
)Specify a Key Management Service key ID to encrypt the managed storage.
fargateEphemeralStorageKmsKeyId
— (String
)Specify the Key Management Service key ID for the Fargate ephemeral storage.
status
— (String
)The status of the cluster. The following are the possible states that are returned.
- ACTIVE
-
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
-
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
-
The cluster has been deleted. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVE
clusters persisting.
registeredContainerInstancesCount
— (Integer
)The number of container instances registered into the cluster. This includes container instances in both
ACTIVE
andDRAINING
status.runningTasksCount
— (Integer
)The number of tasks in the cluster that are in the
RUNNING
state.pendingTasksCount
— (Integer
)The number of tasks in the cluster that are in the
PENDING
state.activeServicesCount
— (Integer
)The number of services that are running on the cluster in an
ACTIVE
state. You can view these services with PListServices.statistics
— (Array<map>
)Additional information about your clusters that are separated by launch type. They include the following:
-
runningEC2TasksCount
-
RunningFargateTasksCount
-
pendingEC2TasksCount
-
pendingFargateTasksCount
-
activeEC2ServiceCount
-
activeFargateServiceCount
-
drainingEC2ServiceCount
-
drainingFargateServiceCount
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
-
tags
— (Array<map>
)The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
settings
— (Array<map>
)The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.
name
— (String
)The name of the cluster setting. The value is
Possible values include:containerInsights
."containerInsights"
value
— (String
)The value to set for the cluster setting. The supported values are
enabled
anddisabled
.If you set
name
tocontainerInsights
andvalue
toenabled
, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless thecontainerInsights
account setting is turned on. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
capacityProviders
— (Array<String>
)The capacity providers associated with the cluster.
defaultCapacityProviderStrategy
— (Array<map>
)The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
attachments
— (Array<map>
)The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
id
— (String
)The unique identifier for the attachment.
type
— (String
)The type of the attachment, such as
ElasticNetworkInterface
,Service Connect
, andAmazonElasticBlockStorage
.status
— (String
)The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
,DELETED
, andFAILED
.details
— (Array<map>
)Details of the attachment.
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
For Service Connect services, this includes
portName
,clientAliases
,discoveryName
, andingressPortOverride
.For Elastic Block Storage, this includes
roleArn
,deleteOnTermination
,volumeName
,volumeId
, andstatusReason
(only when the attachment fails to create or attach).name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
attachmentsStatus
— (String
)The status of the capacity providers associated with the cluster. The following are the states that are returned.
- UPDATE_IN_PROGRESS
-
The available capacity providers for the cluster are updating.
- UPDATE_COMPLETE
-
The capacity providers have successfully updated.
- UPDATE_FAILED
-
The capacity provider updates failed.
serviceConnectDefaults
— (map
)Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the
enabled
parameter totrue
in theServiceConnectConfiguration
. You can set the namespace of each service individually in theServiceConnectConfiguration
to override this default parameter.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
namespace
— (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
-
(AWS.Response)
—
Returns:
describeContainerInstances(params = {}, callback) ⇒ AWS.Request
Describes one or more container instances. Returns metadata about each container instance requested.
Service Reference:
Examples:
To describe container instance
/* This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier. */ var params = { cluster: "default", containerInstances: [ "f2756532-8f13-4d53-87c9-aed50dc94cd7" ] }; ecs.describeContainerInstances(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { containerInstances: [ { agentConnected: true, containerInstanceArn: "arn:aws:ecs:us-east-1:012345678910:container-instance/default/f2756532-8f13-4d53-87c9-aed50dc94cd7", ec2InstanceId: "i-807f3249", pendingTasksCount: 0, registeredResources: [ { name: "CPU", type: "INTEGER", doubleValue: 0.0, integerValue: 2048, longValue: 0 }, { name: "MEMORY", type: "INTEGER", doubleValue: 0.0, integerValue: 3768, longValue: 0 }, { name: "PORTS", type: "STRINGSET", doubleValue: 0.0, integerValue: 0, longValue: 0, stringSetValue: [ "2376", "22", "51678", "2375" ] } ], remainingResources: [ { name: "CPU", type: "INTEGER", doubleValue: 0.0, integerValue: 1948, longValue: 0 }, { name: "MEMORY", type: "INTEGER", doubleValue: 0.0, integerValue: 3668, longValue: 0 }, { name: "PORTS", type: "STRINGSET", doubleValue: 0.0, integerValue: 0, longValue: 0, stringSetValue: [ "2376", "22", "80", "51678", "2375" ] } ], runningTasksCount: 1, status: "ACTIVE" } ], failures: [ ] } */ });
Calling the describeContainerInstances operation
var params = { containerInstances: [ /* required */ 'STRING_VALUE', /* more items */ ], cluster: 'STRING_VALUE', include: [ TAGS | CONTAINER_INSTANCE_HEALTH, /* more items */ ] }; ecs.describeContainerInstances(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)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. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
containerInstances
— (Array<String>
)A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
include
— (Array<String>
)Specifies whether you want to see the resource tags for the container instance. If
TAGS
is specified, the tags are included in the response. IfCONTAINER_INSTANCE_HEALTH
is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:containerInstances
— (Array<map>
)The list of container instances.
containerInstanceArn
— (String
)The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
ec2InstanceId
— (String
)The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
capacityProviderName
— (String
)The capacity provider that's associated with the container instance.
version
— (Integer
)The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the
detail
object) to verify that the version in your event stream is current.versionInfo
— (map
)The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
agentVersion
— (String
)The version number of the Amazon ECS container agent.
agentHash
— (String
)The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
dockerVersion
— (String
)The Docker version that's running on the container instance.
remainingResources
— (Array<map>
)For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the
host
orbridge
network mode). Any port that's not specified here is available for new tasks.name
— (String
)The name of the resource, such as
CPU
,MEMORY
,PORTS
,PORTS_UDP
, or a user-defined resource.type
— (String
)The type of the resource. Valid values:
INTEGER
,DOUBLE
,LONG
, orSTRINGSET
.doubleValue
— (Float
)When the
doubleValue
type is set, the value of the resource must be a double precision floating-point type.longValue
— (Integer
)When the
longValue
type is set, the value of the resource must be an extended precision floating-point type.integerValue
— (Integer
)When the
integerValue
type is set, the value of the resource must be an integer.stringSetValue
— (Array<String>
)When the
stringSetValue
type is set, the value of the resource must be a string type.
registeredResources
— (Array<map>
)For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
name
— (String
)The name of the resource, such as
CPU
,MEMORY
,PORTS
,PORTS_UDP
, or a user-defined resource.type
— (String
)The type of the resource. Valid values:
INTEGER
,DOUBLE
,LONG
, orSTRINGSET
.doubleValue
— (Float
)When the
doubleValue
type is set, the value of the resource must be a double precision floating-point type.longValue
— (Integer
)When the
longValue
type is set, the value of the resource must be an extended precision floating-point type.integerValue
— (Integer
)When the
integerValue
type is set, the value of the resource must be an integer.stringSetValue
— (Array<String>
)When the
stringSetValue
type is set, the value of the resource must be a string type.
status
— (String
)The status of the container instance. The valid values are
REGISTERING
,REGISTRATION_FAILED
,ACTIVE
,INACTIVE
,DEREGISTERING
, orDRAINING
.If your account has opted in to the
awsvpcTrunking
account setting, then any newly registered container instance will transition to aREGISTERING
status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to aREGISTRATION_FAILED
status. You can describe the container instance and see the reason for failure in thestatusReason
parameter. Once the container instance is terminated, the instance transitions to aDEREGISTERING
status while the trunk elastic network interface is deprovisioned. The instance then transitions to anINACTIVE
status.The
ACTIVE
status indicates that the container instance can accept tasks. TheDRAINING
indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.statusReason
— (String
)The reason that the container instance reached its current status.
agentConnected
— (Boolean
)This parameter returns
true
if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped returnfalse
. Only instances connected to an agent can accept task placement requests.runningTasksCount
— (Integer
)The number of tasks on the container instance that have a desired status (
desiredStatus
) ofRUNNING
.pendingTasksCount
— (Integer
)The number of tasks on the container instance that are in the
PENDING
status.agentUpdateStatus
— (String
)The status of the most recent agent update. If an update wasn't ever requested, this value is
Possible values include:NULL
."PENDING"
"STAGING"
"STAGED"
"UPDATING"
"UPDATED"
"FAILED"
attributes
— (Array<map>
)The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
registeredAt
— (Date
)The Unix timestamp for the time when the container instance was registered.
attachments
— (Array<map>
)The resources attached to a container instance, such as an elastic network interface.
id
— (String
)The unique identifier for the attachment.
type
— (String
)The type of the attachment, such as
ElasticNetworkInterface
,Service Connect
, andAmazonElasticBlockStorage
.status
— (String
)The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
,DELETED
, andFAILED
.details
— (Array<map>
)Details of the attachment.
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
For Service Connect services, this includes
portName
,clientAliases
,discoveryName
, andingressPortOverride
.For Elastic Block Storage, this includes
roleArn
,deleteOnTermination
,volumeName
,volumeId
, andstatusReason
(only when the attachment fails to create or attach).name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags
— (Array<map>
)The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
healthStatus
— (map
)An object representing the health status of the container instance.
overallStatus
— (String
)The overall health status of the container instance. This is an aggregate status of all container instance health checks.
Possible values include:"OK"
"IMPAIRED"
"INSUFFICIENT_DATA"
"INITIALIZING"
details
— (Array<map>
)An array of objects representing the details of the container instance health status.
type
— (String
)The type of container instance health status that was verified.
Possible values include:"CONTAINER_RUNTIME"
status
— (String
)The container instance health status.
Possible values include:"OK"
"IMPAIRED"
"INSUFFICIENT_DATA"
"INITIALIZING"
lastUpdated
— (Date
)The Unix timestamp for when the container instance health status was last updated.
lastStatusChange
— (Date
)The Unix timestamp for when the container instance health status last changed.
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
-
(AWS.Response)
—
Returns:
describeServices(params = {}, callback) ⇒ AWS.Request
Describes the specified services running in your cluster.
Service Reference:
Examples:
To describe a service
/* This example provides descriptive information about the service named ``ecs-simple-service``. */ var params = { services: [ "ecs-simple-service" ] }; ecs.describeServices(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { failures: [ ], services: [ { clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", createdAt: <Date Representation>, deploymentConfiguration: { maximumPercent: 200, minimumHealthyPercent: 100 }, deployments: [ { createdAt: <Date Representation>, desiredCount: 1, id: "ecs-svc/9223370564341623665", pendingCount: 0, runningCount: 0, status: "PRIMARY", taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", updatedAt: <Date Representation> } ], desiredCount: 1, events: [ { createdAt: <Date Representation>, id: "38c285e5-d335-4b68-8b15-e46dedc8e88d", message: "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide."// In this example, there is a service event that shows unavailable cluster resources. } ], loadBalancers: [ ], pendingCount: 0, runningCount: 0, serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", serviceName: "ecs-simple-service", status: "ACTIVE", taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6" } ] } */ });
Calling the describeServices operation
var params = { services: [ /* required */ 'STRING_VALUE', /* more items */ ], cluster: 'STRING_VALUE', include: [ TAGS, /* more items */ ] }; ecs.describeServices(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.
services
— (Array<String>
)A list of services to describe. You may specify up to 10 services to describe in a single operation.
include
— (Array<String>
)Determines whether you want to see the resource tags for the service. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:services
— (Array<map>
)The list of services described.
serviceArn
— (String
)The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
serviceName
— (String
)The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that hosts the service.
loadBalancers
— (Array<map>
)A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
status
— (String
)The status of the service. The valid values are
ACTIVE
,DRAINING
, orINACTIVE
.desiredCount
— (Integer
)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.
runningCount
— (Integer
)The number of tasks in the cluster that are in the
RUNNING
state.pendingCount
— (Integer
)The number of tasks in the cluster that are in the
PENDING
state.launchType
— (String
)The 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.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.platformFamily
— (String
)The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily
value as the service (for example,LINUX
).taskDefinition
— (String
)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
— (map
)Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentCircuitBreaker
— (map
)Note: The deployment circuit breaker can only be used for services using the rolling update (ECS
) deployment type.The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide
enable
— required — (Boolean
)Determines whether to use the deployment circuit breaker logic for the service.
rollback
— required — (Boolean
)Determines 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.
maximumPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, themaximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in theRUNNING
orPENDING
state during a deployment, as a percentage of thedesiredCount
(rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using theREPLICA
service scheduler and has adesiredCount
of four tasks and amaximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The defaultmaximumPercent
value for a service using theREPLICA
service scheduler is 200%.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.minimumHealthyPercent
— (Integer
)If a service is using the rolling update (
ECS
) deployment type, theminimumHealthyPercent
represents a lower limit on the number of your service's tasks that must remain in theRUNNING
state during a deployment, as a percentage of thedesiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has adesiredCount
of four tasks and aminimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.For services that do not use a load balancer, the following should be noted:
-
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
-
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a
RUNNING
state before the task is counted towards the minimum healthy percent total. -
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
-
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
-
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
The default value for a replica service for
minimumHealthyPercent
is 100%. The defaultminimumHealthyPercent
value for a service using theDAEMON
service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.The minimum number of healthy tasks during a deployment is the
desiredCount
multiplied by theminimumHealthyPercent
/100, rounded up to the nearest integer value.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.-
alarms
— (map
)Information about the CloudWatch alarms.
alarmNames
— required — (Array<String>
)One or more CloudWatch alarm names. Use a "," to separate the alarms.
enable
— required — (Boolean
)Determines whether to use the CloudWatch alarm option in the service deployment process.
rollback
— required — (Boolean
)Determines 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.
taskSets
— (Array<map>
)Information about a set of Amazon ECS tasks in either an CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.id
— (String
)The ID of the task set.
taskSetArn
— (String
)The Amazon Resource Name (ARN) of the task set.
serviceArn
— (String
)The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy
— (String
)The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
startedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.externalId
— (String
)The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.status
— (String
)The status of the task set. The following describes each state.
- PRIMARY
-
The task set is serving production traffic.
- ACTIVE
-
The task set isn't serving production traffic.
- DRAINING
-
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
taskDefinition
— (String
)The task definition that the task set is using.
computedDesiredCount
— (Integer
)The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.pendingCount
— (Integer
)The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.runningCount
— (Integer
)The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.createdAt
— (Date
)The Unix timestamp for the time when the task set was created.
updatedAt
— (Date
)The Unix timestamp for the time when the task set was last updated.
launchType
— (String
)The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that are associated with the task set.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
platformFamily
— (String
)The 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.
All tasks in the set must have the same value.
networkConfiguration
— (map
)The network configuration for the task set.
awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
loadBalancers
— (Array<map>
)Details on a load balancer that are used with a task set.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
scale
— (map
)A floating-point percentage of your desired number of tasks to place and keep running in the task set.
value
— (Float
)The value, specified as a percent total of a service's
desiredCount
, to scale the task set. Accepted values are numbers between 0 and 100.unit
— (String
)The unit of measure for the scale value.
Possible values include:"PERCENT"
stabilityStatus
— (String
)The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are running on container instances in the
DRAINING
status. -
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
Possible values include:STABILIZING
."STEADY_STATE"
"STABILIZING"
-
stabilityStatusAt
— (Date
)The Unix timestamp for the time when the task set stability status was retrieved.
tags
— (Array<map>
)The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the task set.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
deployments
— (Array<map>
)The current state of deployments for the service.
id
— (String
)The ID of the deployment.
status
— (String
)The status of the deployment. The following describes each state.
- PRIMARY
-
The most recent deployment of a service.
- ACTIVE
-
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment. - INACTIVE
-
A deployment that has been completely replaced.
taskDefinition
— (String
)The most recent task definition that was specified for the tasks in the service to use.
desiredCount
— (Integer
)The most recent desired count of tasks that was specified for the service to deploy or maintain.
pendingCount
— (Integer
)The number of tasks in the deployment that are in the
PENDING
status.runningCount
— (Integer
)The number of tasks in the deployment that are in the
RUNNING
status.failedTasks
— (Integer
)The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a
RUNNING
state, or if it fails any of its defined health checks and is stopped.Note: Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.createdAt
— (Date
)The Unix timestamp for the time when the service deployment was created.
updatedAt
— (Date
)The Unix timestamp for the time when the service deployment was last updated.
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that the deployment is using.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
launchType
— (String
)The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
platformVersion
— (String
)The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the
LATEST
platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.platformFamily
— (String
)The 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.
All tasks that run as part of this service must use the same
platformFamily
value as the service, for example,LINUX.
.networkConfiguration
— (map
)The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode.awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
rolloutState
— (String
)Note: TherolloutState
of a service is only returned for services that use the rolling update (ECS
) deployment type that aren't behind a Classic Load Balancer.The rollout state of the deployment. When a service deployment is started, it begins in an
Possible values include:IN_PROGRESS
state. When the service reaches a steady state, the deployment transitions to aCOMPLETED
state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to aFAILED
state. A deployment inFAILED
state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker."COMPLETED"
"FAILED"
"IN_PROGRESS"
rolloutStateReason
— (String
)A description of the rollout state of a deployment.
serviceConnectConfiguration
— (map
)The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
enabled
— required — (Boolean
)Specifies whether to use Service Connect with this service.
namespace
— (String
)The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
services
— (Array<map>
)The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
portName
— required — (String
)The
portName
must match the name of one of theportMappings
from all the containers in the task definition of this Amazon ECS service.discoveryName
— (String
)The
discoveryName
is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.If the
discoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.clientAliases
— (Array<map>
)The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each
ServiceConnectService
, you must provide at least oneclientAlias
with oneport
.port
— required — (Integer
)The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
dnsName
— (String
)The
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. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.If this parameter isn't specified, the default value of
discoveryName.namespace
is used. If thediscoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are
database
,db
, or the lowercase name of a database, such asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
ingressPortOverride
— (Integer
)The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port number specified in the named
portMapping
in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.In
awsvpc
mode and Fargate, the default value is the container port number. The container port number is in theportMapping
in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.timeout
— (map
)A reference to an object that represents the configured timeouts for Service Connect.
idleTimeoutSeconds
— (Integer
)The amount of time in seconds a connection will stay active while idle. A value of
0
can be set to disableidleTimeout
.The
idleTimeout
default forHTTP
/HTTP2
/GRPC
is 5 minutes.The
idleTimeout
default forTCP
is 1 hour.perRequestTimeoutSeconds
— (Integer
)The amount of time waiting for the upstream to respond with a complete response per request. A value of
0
can be set to disableperRequestTimeout
.perRequestTimeout
can only be set if Service ConnectappProtocol
isn'tTCP
. OnlyidleTimeout
is allowed forTCP
appProtocol
.
tls
— (map
)A reference to an object that represents a Transport Layer Security (TLS) configuration.
issuerCertificateAuthority
— required — (map
)The signer certificate authority.
awsPcaAuthorityArn
— (String
)The ARN of the Amazon Web Services Private Certificate Authority certificate.
kmsKey
— (String
)The Amazon Web Services Key Management Service key.
roleArn
— (String
)The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.
logConfiguration
— (map
)The log configuration for the container. This parameter maps to
LogConfig
in the docker conainer create command and the--log-driver
option to docker run.By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.
Understand the following when specifying a log configuration for your containers.
-
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
. -
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
-
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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 Elastic Container Service Developer Guide. -
For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
logDriver
— required — (String
)The log driver to use for the container.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.Possible values include:"json-file"
"syslog"
"journald"
"gelf"
"fluentd"
"awslogs"
"splunk"
"awsfirelens"
options
— (map<String>
)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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
secretOptions
— (Array<map>
)The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
-
serviceConnectResources
— (Array<map>
)The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.
discoveryName
— (String
)The discovery name of this Service Connect resource.
The
discoveryName
is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.If the
discoveryName
isn't specified, the port mapping name from the task definition is used inportName.namespace
.discoveryArn
— (String
)The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.
volumeConfigurations
— (Array<map>
)The details of the volume that was
configuredAtLaunch
. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. Thename
of the volume must match thename
from the task definition.name
— required — (String
)The name of the volume. This value must match the volume name from the
Volume
object in the task definition.managedEBSVolume
— (map
)The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.
encrypted
— (Boolean
)Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the
Encrypted
parameter of the CreateVolume API in the Amazon EC2 API Reference.kmsKeyId
— (String
)The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the
KmsKeyId
parameter of the CreateVolume API in the Amazon EC2 API Reference.Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
volumeType
— (String
)The volume type. This parameter maps 1:1 with the
VolumeType
parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.The following are the supported volume types.
-
General Purpose SSD:
gp2
|gp3
-
Provisioned IOPS SSD:
io1
|io2
-
Throughput Optimized HDD:
st1
-
Cold HDD:
sc1
-
Magnetic:
standard
Note: The magnetic volume type is not supported on Fargate.
-
sizeInGiB
— (Integer
)The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
Size
parameter of the CreateVolume API in the Amazon EC2 API Reference.The following are the supported volume size values for each volume type.
-
gp2
andgp3
: 1-16,384 -
io1
andio2
: 4-16,384 -
st1
andsc1
: 125-16,384 -
standard
: 1-1,024
-
snapshotId
— (String
)The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the
SnapshotId
parameter of the CreateVolume API in the Amazon EC2 API Reference.iops
— (Integer
)The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type.
-
gp3
: 3,000 - 16,000 IOPS -
io1
: 100 - 64,000 IOPS -
io2
: 100 - 256,000 IOPS
This parameter is required for
io1
andio2
volume types. The default forgp3
volumes is3,000 IOPS
. This parameter is not supported forst1
,sc1
, orstandard
volume types.This parameter maps 1:1 with the
Iops
parameter of the CreateVolume API in the Amazon EC2 API Reference.-
throughput
— (Integer
)The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the
Throughput
parameter of the CreateVolume API in the Amazon EC2 API Reference.This parameter is only supported for the
gp3
volume type.tagSpecifications
— (Array<map>
)The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the
TagSpecifications.N
parameter of the CreateVolume API in the Amazon EC2 API Reference.resourceType
— required — (String
)The type of volume resource.
Possible values include:"volume"
tags
— (Array<map>
)The tags applied to this Amazon EBS volume.
AmazonECSCreated
andAmazonECSManaged
are reserved tags that can't be used.key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
propagateTags
— (String
)Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a
Possible values include:SERVICE
specified inServiceVolumeConfiguration
. If no value is specified, the tags aren't propagated."TASK_DEFINITION"
"SERVICE"
"NONE"
roleArn
— required — (String
)The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed
AmazonECSInfrastructureRolePolicyForVolumes
IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.filesystemType
— (String
)The 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.
The available filesystem types are
Possible values include:ext3
,ext4
, andxfs
. If no value is specified, thexfs
filesystem type is used by default."ext3"
"ext4"
"xfs"
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the deployment.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
roleArn
— (String
)The 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.
events
— (Array<map>
)The event stream for your service. A maximum of 100 of the latest events are displayed.
id
— (String
)The ID string for the event.
createdAt
— (Date
)The Unix timestamp for the time when the event was triggered.
message
— (String
)The event message.
createdAt
— (Date
)The Unix timestamp for the time when the service was created.
placementConstraints
— (Array<map>
)The placement constraints for the tasks in the service.
type
— (String
)The type of constraint. Use
Possible values include:distinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates."distinctInstance"
"memberOf"
expression
— (String
)A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is
distinctInstance
. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
placementStrategy
— (Array<map>
)The placement strategy that determines how tasks for the service are placed.
type
— (String
)The type of placement strategy. The
Possible values include:random
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that's specified with thefield
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."random"
"spread"
"binpack"
field
— (String
)The field to apply the placement strategy against. For the
spread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that's applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used.
networkConfiguration
— (map
)The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode.awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
healthCheckGracePeriodSeconds
— (Integer
)The 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.
schedulingStrategy
— (String
)The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
-
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. -
DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Note: Fargate tasks don't support theDAEMON
scheduling strategy.
"REPLICA"
"DAEMON"
-
deploymentController
— (map
)The deployment controller type the service is using.
type
— required — (String
)The deployment controller type to use.
There are three deployment controller types available:
- ECS
-
The rolling update (
ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
-
The blue/green (
CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
-
The external (
EXTERNAL
) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
"ECS"
"CODE_DEPLOY"
"EXTERNAL"
tags
— (Array<map>
)The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
createdBy
— (String
)The principal that created the service.
enableECSManagedTags
— (Boolean
)Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
propagateTags
— (String
)Determines 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.
Possible values include:"TASK_DEFINITION"
"SERVICE"
"NONE"
enableExecuteCommand
— (Boolean
)Determines 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.
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeTaskDefinition(params = {}, callback) ⇒ AWS.Request
Describes a task definition. You can specify a
family
andrevision
to find information about a specific task definition, or you can simply specify the family to find the latestACTIVE
revision in that family.Note: You can only describeINACTIVE
task definitions while an active task or service references them.Service Reference:
Examples:
To describe a task definition
/* This example provides a description of the specified task definition. */ var params = { taskDefinition: "hello_world:8" }; ecs.describeTaskDefinition(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { taskDefinition: { containerDefinitions: [ { name: "wordpress", cpu: 10, environment: [ ], essential: true, image: "wordpress", links: [ "mysql" ], memory: 500, mountPoints: [ ], portMappings: [ { containerPort: 80, hostPort: 80 } ], volumesFrom: [ ] }, { name: "mysql", cpu: 10, environment: [ { name: "MYSQL_ROOT_PASSWORD", value: "password" } ], essential: true, image: "mysql", memory: 500, mountPoints: [ ], portMappings: [ ], volumesFrom: [ ] } ], family: "hello_world", revision: 8, taskDefinitionArn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8", volumes: [ ] } } */ });
Calling the describeTaskDefinition operation
var params = { taskDefinition: 'STRING_VALUE', /* required */ include: [ TAGS, /* more items */ ] }; ecs.describeTaskDefinition(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
taskDefinition
— (String
)The
family
for the latestACTIVE
revision,family
andrevision
(family:revision
) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.include
— (Array<String>
)Determines whether to see the resource tags for the task definition. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:taskDefinition
— (map
)The full task definition description.
taskDefinitionArn
— (String
)The full Amazon Resource Name (ARN) of the task definition.
containerDefinitions
— (Array<map>
)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 Elastic Container Service Developer Guide.
name
— (String
)The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in thelinks
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps toname
in tthe docker conainer create command and the--name
option to docker run.image
— (String
)The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
orrepository-url/image@digest
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImage
in the docker conainer create command and theIMAGE
parameter of docker run.-
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
-
Images in Amazon ECR repositories can be specified by either using the full
registry/repository:tag
orregistry/repository@digest
. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
. -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
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
).
-
repositoryCredentials
— (map
)The private repository authentication credentials to use.
credentialsParameter
— required — (String
)The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
Note: When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
cpu
— (Integer
)The number of
cpu
units reserved for the container. This parameter maps toCpuShares
in the docker conainer create commandand the--cpu-shares
option to docker run.This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level
cpu
value.Note: 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.Linux containers share unallocated CPU units with other containers on the container 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, 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 two 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.
-
Agent versions greater than or equal to 1.84.0: CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as
0
, which Windows interprets as 1% of one CPU.-
memory
— (Integer
)The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memory
value, if one is specified. This parameter maps toMemory
in thethe docker conainer create command and the--memory
option to docker run.If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level
memory
andmemoryReservation
value,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
is used.The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memoryReservation
— (Integer
)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 toMemoryReservation
in the the docker conainer create command and the--memory-reservation
option to docker run.If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
ormemoryReservation
in a container definition. If you specify both,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
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 amemory
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.The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
links
— (Array<String>
)The
links
parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge
. Thename:internalName
construct is analogous toname:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps toLinks
in the docker conainer create command and the--link
option to docker run.Note: This parameter is not supported for Windows containers.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.
portMappings
— (Array<map>
)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.
For task definitions that use the
awsvpc
network mode, only specify thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.This parameter maps to
PortBindings
in the the docker conainer create command and the--publish
option to docker run. If the network mode of a task definition is set tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, then host ports must either be undefined or they must match the container port in the port mapping.Note: After a task reaches theRUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindings
section DescribeTasks responses.containerPort
— (Integer
)The port number on the container that's bound to the user-specified or automatically assigned host port.
If you use containers in a task with the
awsvpc
orhost
network mode, specify the exposed ports usingcontainerPort
.If you use containers in a task with the
bridge
network mode and 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, seehostPort
. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.hostPort
— (Integer
)The port number on the container instance to reserve for your container.
If you specify a
containerPortRange
, leave this field empty and the value of thehostPort
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPort
is set to the same value as thecontainerPort
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.
If you use containers in a task with the
awsvpc
orhost
network mode, thehostPort
can either be left blank or set to the same value as thecontainerPort
.If you use containers in a task with the
bridge
network mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort
(or set it to0
) while specifying acontainerPort
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 for Docker version 1.6.0 and later is listed on the instance under
/proc/sys/net/ipv4/ip_local_port_range
. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as 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 ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.-
protocol
— (String
)The protocol used for the port mapping. Valid values are
Possible values include:tcp
andudp
. The default istcp
.protocol
is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment."tcp"
"udp"
name
— (String
)The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfiguration
of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
appProtocol
— (String
)The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocol
is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
Possible values include:"http"
"http2"
"grpc"
containerPortRange
— (String
)The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a
containerPortRange
:-
You must use either the
bridge
network mode or theawsvpc
network mode. -
This parameter is available for both the EC2 and Fargate launch types.
-
This parameter is available for both the Linux and Windows operating systems.
-
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the
ecs-init
package -
You can specify a maximum of 100 port ranges per container.
-
You do not specify a
hostPortRange
. The value of thehostPortRange
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPortRange
is set to the same value as thecontainerPortRange
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
-
-
The
containerPortRange
valid values are between 1 and 65535. -
A port can only be included in one port mapping per container.
-
You cannot specify overlapping port ranges.
-
The first port in the range must be less than last port in the range.
-
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view thehostPortRange
which are the host ports that are bound to the container ports.-
essential
— (Boolean
)If the
essential
parameter of a container is marked astrue
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessential
parameter of a container is marked asfalse
, its failure doesn't 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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
restartPolicy
— (map
)The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
enabled
— required — (Boolean
)Specifies whether a restart policy is enabled for the container.
ignoredExitCodes
— (Array<Integer>
)A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.
restartAttemptPeriod
— (Integer
)A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every
restartAttemptPeriod
seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimumrestartAttemptPeriod
of 60 seconds and a maximumrestartAttemptPeriod
of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.
entryPoint
— (Array<String>
)Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
array items instead.The entry point that's passed to the container. This parameter maps to
Entrypoint
in tthe docker conainer create command and the--entrypoint
option to docker run.command
— (Array<String>
)The command that's passed to the container. This parameter maps to
Cmd
in the docker conainer create command and theCOMMAND
parameter to docker run. If there are multiple arguments, each argument is a separated string in the array.environment
— (Array<map>
)The environment variables to pass to a container. This parameter maps to
Env
in the docker conainer create command and the--env
option to docker run.We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
environmentFiles
— (Array<map>
)A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.You can specify up to ten environment files. The file must have a
.env
file extension. Each line in an environment file contains an environment variable inVARIABLE=VALUE
format. Lines beginning with#
are treated as comments and are ignored.If there are environment variables specified using the
environment
parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.value
— required — (String
)The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type
— required — (String
)The file type to use. Environment files are objects in Amazon S3. The only supported value is
Possible values include:s3
."s3"
mountPoints
— (Array<map>
)The mount points for data volumes in your container.
This parameter maps to
Volumes
in the the docker conainer create command and the--volume
option to docker run.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives.sourceVolume
— (String
)The name of the volume to mount. Must be a volume name referenced in the
name
parameter of task definitionvolume
.containerPath
— (String
)The path on the container to mount the host volume at.
readOnly
— (Boolean
)If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
volumesFrom
— (Array<map>
)Data volumes to mount from another container. This parameter maps to
VolumesFrom
in tthe docker conainer create command and the--volumes-from
option to docker run.sourceContainer
— (String
)The name of another container within the same task definition to mount volumes from.
readOnly
— (Boolean
)If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
.
linuxParameters
— (map
)Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
Note: This parameter is not supported for Windows containers.capabilities
— (map
)The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note: For tasks that use the Fargate launch type,capabilities
is supported for all platform versions but theadd
parameter is only supported if using platform version 1.4.0 or later.add
— (Array<String>
)The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAdd
in the docker conainer create command and the--cap-add
option to docker run.Note: Tasks launched on Fargate only support adding theSYS_PTRACE
kernel capability.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
drop
— (Array<String>
)The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDrop
in the docker conainer create command and the--cap-drop
option to docker run.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
devices
— (Array<map>
)Any host devices to expose to the container. This parameter maps to
Devices
in tthe docker conainer create command and the--device
option to docker run.Note: If you're using tasks that use the Fargate launch type, thedevices
parameter isn't supported.hostPath
— required — (String
)The path for the device on the host container instance.
containerPath
— (String
)The path inside the container at which to expose the host device.
permissions
— (Array<String>
)The explicit permissions to provide to the container for the device. By default, the container has permissions for
read
,write
, andmknod
for the device.
initProcessEnabled
— (Boolean
)Run an
init
process inside the container that forwards signals and reaps processes. This parameter maps to the--init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
sharedMemorySize
— (Integer
)The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run.Note: If you are using tasks that use the Fargate launch type, thesharedMemorySize
parameter is not supported.tmpfs
— (Array<map>
)The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run.Note: If you're using tasks that use the Fargate launch type, thetmpfs
parameter isn't supported.containerPath
— required — (String
)The absolute file path where the tmpfs volume is to be mounted.
size
— required — (Integer
)The maximum size (in MiB) of the tmpfs volume.
mountOptions
— (Array<String>
)The list of tmpfs volume mount options.
Valid values:
"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
maxSwap
— (Integer
)The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swap
option to docker run where the value would be the sum of the container memory plus themaxSwap
value.If a
maxSwap
value of0
is specified, the container will not use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
parameter to be used.Note: If you're using tasks that use the Fargate launch type, themaxSwap
parameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappiness
parameter isn't supported.swappiness
— (Integer
)This allows you to tune a container's memory swappiness behavior. A
swappiness
value of0
will cause swapping to not happen unless absolutely necessary. Aswappiness
value of100
will cause pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter is not specified, a default value of60
is used. If a value is not specified formaxSwap
then this parameter is ignored. This parameter maps to the--memory-swappiness
option to docker run.Note: If you're using tasks that use the Fargate launch type, theswappiness
parameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappiness
parameter isn't supported.
secrets
— (Array<map>
)The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
dependsOn
— (Array<map>
)The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
containerName
— required — (String
)The name of a container.
condition
— required — (String
)The dependency condition of the container. The following are the available conditions and their behavior:
-
START
- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. -
COMPLETE
- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. -
SUCCESS
- This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition can't be set on an essential container. -
HEALTHY
- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
"START"
"COMPLETE"
"SUCCESS"
"HEALTHY"
-
-
startTimeout
— (Integer
)Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE
,SUCCESS
, orHEALTHY
status. If astartTimeout
value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPED
state.Note: When theECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's enforced independently from this start timeout value.For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version
1.26.0
of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1
of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.The valid values for Fargate are 2-120 seconds.
-
stopTimeout
— (Integer
)Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
-
Linux platform version
1.3.0
or later. -
Windows platform version
1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the
stopTimeout
parameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUT
is used. If neither thestopTimeout
parameter or theECS_CONTAINER_STOP_TIMEOUT
agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.The valid values are 2-120 seconds.
-
hostname
— (String
)The hostname to use for your container. This parameter maps to
Hostname
in thethe docker conainer create command and the--hostname
option to docker run.Note: Thehostname
parameter is not supported if you're using theawsvpc
network mode.user
— (String
)The user to use inside the container. This parameter maps to
User
in the docker conainer create command and the--user
option to docker run.When running tasks using the
host
network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.You can specify the
user
using the following formats. If specifying a UID or GID, you must specify it as a positive integer.-
user
-
user:group
-
uid
-
uid:gid
-
user:gid
-
uid:group
Note: This parameter is not supported for Windows containers.-
workingDirectory
— (String
)The working directory to run commands inside the container in. This parameter maps to
WorkingDir
in the docker conainer create command and the--workdir
option to docker run.disableNetworking
— (Boolean
)When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the docker conainer create command.Note: This parameter is not supported for Windows containers.privileged
— (Boolean
)When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
root
user). This parameter maps toPrivileged
in the the docker conainer create command and the--privileged
option to docker runNote: This parameter is not supported for Windows containers or tasks run on Fargate.readonlyRootFilesystem
— (Boolean
)When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the docker conainer create command and the--read-only
option to docker run.Note: This parameter is not supported for Windows containers.dnsServers
— (Array<String>
)A list of DNS servers that are presented to the container. This parameter maps to
Dns
in the the docker conainer create command and the--dns
option to docker run.Note: This parameter is not supported for Windows containers.dnsSearchDomains
— (Array<String>
)A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the docker conainer create command and the--dns-search
option to docker run.Note: This parameter is not supported for Windows containers.extraHosts
— (Array<map>
)A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps toExtraHosts
in the docker conainer create command and the--add-host
option to docker run.Note: This parameter isn't supported for Windows containers or tasks that use theawsvpc
network mode.hostname
— required — (String
)The hostname to use in the
/etc/hosts
entry.ipAddress
— required — (String
)The IP address to use in the
/etc/hosts
entry.
dockerSecurityOptions
— (Array<String>
)A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to
SecurityOpt
in the docker conainer create command and the--security-opt
option to docker run.Note: The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=true
orECS_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 Elastic Container Service Developer Guide.Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
interactive
— (Boolean
)When this parameter is
true
, you can deploy containerized applications that requirestdin
or atty
to be allocated. This parameter maps toOpenStdin
in the docker conainer create command and the--interactive
option to docker run.pseudoTerminal
— (Boolean
)When this parameter is
true
, a TTY is allocated. This parameter maps toTty
in tthe docker conainer create command and the--tty
option to docker run.dockerLabels
— (map<String>
)A key/value map of labels to add to the container. This parameter maps to
Labels
in the docker conainer create command 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 in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
ulimits
— (Array<map>
)A list of
ulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
in tthe docker conainer create command and the--ulimit
option to docker run. Valid naming values are displayed in the Ulimit data type.Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the
nofile
resource limit parameter which Fargate overrides. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is65535
and the default hard limit is65535
.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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Note: This parameter is not supported for Windows containers.name
— required — (String
)The
Possible values include:type
of theulimit
."core"
"cpu"
"data"
"fsize"
"locks"
"memlock"
"msgqueue"
"nice"
"nofile"
"nproc"
"rss"
"rtprio"
"rttime"
"sigpending"
"stack"
softLimit
— required — (Integer
)The soft limit for the
ulimit
type.hardLimit
— required — (Integer
)The hard limit for the
ulimit
type.
logConfiguration
— (map
)The log configuration specification for the container.
This parameter maps to
LogConfig
in the docker conainer create command and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can 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).Note: Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional 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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_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 Elastic Container Service Developer Guide.logDriver
— required — (String
)The log driver to use for the container.
For tasks on Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.Note: If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.Possible values include:"json-file"
"syslog"
"journald"
"gelf"
"fluentd"
"awslogs"
"splunk"
"awsfirelens"
options
— (map<String>
)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 in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
secretOptions
— (Array<map>
)The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name
— required — (String
)The name of the secret.
valueFrom
— required — (String
)The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
Note: If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
healthCheck
— (map
)The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheck
in the docker conainer create command and theHEALTHCHECK
parameter of docker run.command
— required — (Array<String>
)A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMD
to run the command arguments directly, orCMD-SHELL
to run the command with the container's default shell.When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
CMD-SHELL, curl -f http://localhost/ || exit 1
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see
HealthCheck
in tthe docker conainer create commandinterval
— (Integer
)The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
timeout
— (Integer
)The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
retries
— (Integer
)The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
startPeriod
— (Integer
)The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriod
is off.Note: If a health check succeeds within thestartPeriod
, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
systemControls
— (Array<map>
)A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctls
in tthe docker conainer create command and the--sysctl
option to docker run. For example, you can configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.namespace
— (String
)The namespaced kernel parameter to set a
value
for.value
— (String
)The namespaced kernel parameter to set a
value
for.Valid IPC namespace values:
"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"
, andSysctls
that start with"fs.mqueue.*"
Valid network namespace values:
Sysctls
that start with"net.*"
All of these values are supported by Fargate.
resourceRequirements
— (Array<map>
)The type and amount of a resource to assign to a container. The only supported resource is a GPU.
value
— required — (String
)The value for the specified resource type.
When the type is
GPU
, the value is the number of physicalGPUs
the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.When the type is
InferenceAccelerator
, thevalue
matches thedeviceName
for an InferenceAccelerator specified in a task definition.type
— required — (String
)The type of resource to assign to a container.
Possible values include:"GPU"
"InferenceAccelerator"
firelensConfiguration
— (map
)The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
type
— required — (String
)The log router to use. The valid values are
Possible values include:fluentd
orfluentbit
."fluentd"
"fluentbit"
options
— (map<String>
)The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.Note: Tasks hosted on Fargate only support thefile
configuration file type.
credentialSpecs
— (Array<String>
)A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec
) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
with an additional section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
for a single domain.You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace
MyARN
with the ARN in SSM or Amazon S3.If you provide a
credentialspecdomainless:MyARN
, thecredspec
must provide a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers.
family
— (String
)The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
taskRoleArn
— (String
)The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
executionRoleArn
— (String
)The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
networkMode
— (String
)The Docker networking mode to use for the containers in the task. The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.For Amazon ECS tasks on Fargate, the
awsvpc
network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,<default>
orawsvpc
can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.When using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.If the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.If the network mode is
Possible values include:host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used."bridge"
"host"
"awsvpc"
"none"
revision
— (Integer
)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 that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.volumes
— (Array<map>
)The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
Note: Thehost
andsourcePath
parameters aren't supported for tasks run on Fargate.name
— (String
)The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
When using a volume configured at launch, the
name
is required and must also be specified as the volume name in theServiceVolumeConfiguration
orTaskVolumeConfiguration
parameter when creating your service or standalone task.For all other types of volumes, this name is referenced in the
sourceVolume
parameter of themountPoints
object in the container definition.When a volume is using the
efsVolumeConfiguration
, the name is required.host
— (map
)This parameter is specified when you use bind mount host volumes. The contents of the
host
parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehost
parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\path
andD::D:\
, but notD:\my\path:C:\my\path
orD::C:\my\path
.sourcePath
— (String
)When the
host
parameter is used, specify asourcePath
to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehost
parameter contains asourcePath
file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePath
value doesn't 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.If you're using the Fargate launch type, the
sourcePath
parameter is not supported.
dockerVolumeConfiguration
— (map
)This parameter is specified when you use Docker volumes.
Windows containers only support the use of the
local
driver. To use bind mounts, specify thehost
parameter instead.Note: Docker volumes aren't supported by tasks run on Fargate.scope
— (String
)The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
Possible values include:task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops."task"
"shared"
autoprovision
— (Boolean
)If this value is
true
, the Docker volume is created if it doesn't already exist.Note: This field is only used if thescope
isshared
.driver
— (String
)The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps toDriver
in the docker conainer create command and thexxdriver
option to docker volume create.driverOpts
— (map<String>
)A map of Docker driver-specific options passed through. This parameter maps to
DriverOpts
in the docker create-volume command and thexxopt
option to docker volume create.labels
— (map<String>
)Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the docker conainer create command and thexxlabel
option to docker volume create.
efsVolumeConfiguration
— (map
)This parameter is specified when you use an Amazon Elastic File System file system for task storage.
fileSystemId
— required — (String
)The Amazon EFS file system ID to use.
rootDirectory
— (String
)The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/
will have the same effect as omitting this parameter.If an EFS access point is specified in the
authorizationConfig
, the root directory parameter must either be omitted or set to/
which will enforce the path set on the EFS access point.transitEncryption
— (String
)Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
Possible values include:DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide."ENABLED"
"DISABLED"
transitEncryptionPort
— (Integer
)The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
authorizationConfig
— (map
)The authorization configuration details for the Amazon EFS file system.
accessPointId
— (String
)The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfiguration
must either be omitted or set to/
which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration
. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.iam
— (String
)Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
Possible values include:EFSVolumeConfiguration
. If this parameter is omitted, the default value ofDISABLED
is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide."ENABLED"
"DISABLED"
fsxWindowsFileServerVolumeConfiguration
— (map
)This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
fileSystemId
— required — (String
)The Amazon FSx for Windows File Server file system ID to use.
rootDirectory
— required — (String
)The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
authorizationConfig
— required — (map
)The authorization configuration details for the Amazon FSx for Windows File Server file system.
credentialsParameter
— required — (String
)The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.
domain
— required — (String
)A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
configuredAtLaunch
— (Boolean
)Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurations
object when calling theCreateService
,UpdateService
,RunTask
orStartTask
APIs.
status
— (String
)The status of the task definition.
Possible values include:"ACTIVE"
"INACTIVE"
"DELETE_IN_PROGRESS"
requiresAttributes
— (Array<map>
)The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
Note: This parameter isn't supported for tasks run on Fargate.name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
placementConstraints
— (Array<map>
)An array of placement constraint objects to use for tasks.
Note: This parameter isn't supported for tasks run on Fargate.type
— (String
)The type of constraint. The
Possible values include:MemberOf
constraint restricts selection to be from a group of valid candidates."memberOf"
expression
— (String
)A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
compatibilities
— (Array<String>
)The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
runtimePlatform
— (map
)The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the
runtimePlatform
value of the service.cpuArchitecture
— (String
)The CPU architecture.
You can run your Linux tasks on an ARM-based platform by setting the value to
Possible values include:ARM64
. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate."X86_64"
"ARM64"
operatingSystemFamily
— (String
)The operating system.
Possible values include:"WINDOWS_SERVER_2019_FULL"
"WINDOWS_SERVER_2019_CORE"
"WINDOWS_SERVER_2016_FULL"
"WINDOWS_SERVER_2004_CORE"
"WINDOWS_SERVER_2022_CORE"
"WINDOWS_SERVER_2022_FULL"
"WINDOWS_SERVER_20H2_CORE"
"LINUX"
requiresCompatibilities
— (Array<String>
)The task launch types the task definition was validated against. The valid values are
EC2
,FARGATE
, andEXTERNAL
. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.cpu
— (String
)The number of
cpu
units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for thememory
parameter.If you use the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
-
256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) -
512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) -
1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) -
2048 (2 vCPU) - Available
memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
4096 (4 vCPU) - Available
memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
8192 (8 vCPU) - Available
memory
values: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0
or later. -
16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0
or later.
-
memory
— (String
)The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpu
parameter.-
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) -
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) -
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) -
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpu
values: 2048 (2 vCPU) -
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpu
values: 4096 (4 vCPU) -
Between 16 GB and 60 GB in 4 GB increments - Available
cpu
values: 8192 (8 vCPU)This option requires Linux platform
1.4.0
or later. -
Between 32GB and 120 GB in 8 GB increments - Available
cpu
values: 16384 (16 vCPU)This option requires Linux platform
1.4.0
or later.
-
inferenceAccelerators
— (Array<map>
)The Elastic Inference accelerator that's associated with the task.
deviceName
— required — (String
)The Elastic Inference accelerator device name. The
deviceName
must also be referenced in a container definition as a ResourceRequirement.deviceType
— required — (String
)The Elastic Inference accelerator type to use.
pidMode
— (String
)The process namespace to use for the containers in the task. The valid values are
host
ortask
. On Fargate for Linux containers, the only valid value istask
. For example, monitoring sidecars might needpidMode
to access information about other containers running in the same task.If
host
is specified, all containers within the tasks that specified thehost
PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.If
task
is specified, all containers within the specified task share the same process namespace.If no value is specified, the default is a private namespace for each container.
If the
host
PID mode is used, there's a heightened risk of undesired process namespace exposure.Note: This parameter is not supported for Windows containers.Note: This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform versionPossible values include:1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate."host"
"task"
ipcMode
— (String
)The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then all containers within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.If you are setting namespaced kernel parameters using
systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.-
For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported. -
For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
Note: This parameter is not supported for Windows containers or tasks run on Fargate.Possible values include:"host"
"task"
"none"
-
proxyConfiguration
— (map
)The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.type
— (String
)The proxy type. The only supported value is
Possible values include:APPMESH
."APPMESH"
containerName
— required — (String
)The name of the container that will serve as the App Mesh proxy.
properties
— (Array<map>
)The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
-
IgnoredUID
- (Required) The user ID (UID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGID
is specified, this field can be empty. -
IgnoredGID
- (Required) The group ID (GID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUID
is specified, this field can be empty. -
AppPorts
- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPort
andProxyEgressPort
. -
ProxyIngressPort
- (Required) Specifies the port that incoming traffic to theAppPorts
is directed to. -
ProxyEgressPort
- (Required) Specifies the port that outgoing traffic from theAppPorts
is directed to. -
EgressIgnoredPorts
- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort
. It can be an empty list. -
EgressIgnoredIPs
- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort
. It can be an empty list.
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
-
registeredAt
— (Date
)The Unix timestamp for the time when the task definition was registered.
deregisteredAt
— (Date
)The Unix timestamp for the time when the task definition was deregistered.
registeredBy
— (String
)The principal that registered the task definition.
ephemeralStorage
— (map
)The ephemeral storage settings to use for tasks run with the task definition.
sizeInGiB
— required — (Integer
)The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
20
GiB and the maximum supported value is200
GiB.
tags
— (Array<map>
)The metadata that's applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
-
(AWS.Response)
—
Returns:
describeTasks(params = {}, callback) ⇒ AWS.Request
Describes a specified task or tasks.
Currently, stopped tasks appear in the returned results for at least one hour.
If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.
Service Reference:
Examples:
To describe a task
/* This example provides a description of the specified task, using the task UUID as an identifier. */ var params = { tasks: [ "c5cba4eb-5dad-405e-96db-71ef8eefe6a8" ] }; ecs.describeTasks(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { failures: [ ], tasks: [ { clusterArn: "arn:aws:ecs:<region>:<aws_account_id>:cluster/default", containerInstanceArn: "arn:aws:ecs:<region>:<aws_account_id>:container-instance/default/18f9eda5-27d7-4c19-b133-45adc516e8fb", containers: [ { name: "ecs-demo", containerArn: "arn:aws:ecs:<region>:<aws_account_id>:container/7c01765b-c588-45b3-8290-4ba38bd6c5a6", lastStatus: "RUNNING", networkBindings: [ { bindIP: "0.0.0.0", containerPort: 80, hostPort: 80 } ], taskArn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8" } ], desiredStatus: "RUNNING", lastStatus: "RUNNING", overrides: { containerOverrides: [ { name: "ecs-demo" } ] }, startedBy: "ecs-svc/9223370608528463088", taskArn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", taskDefinitionArn: "arn:aws:ecs:<region>:<aws_account_id>:task-definition/amazon-ecs-sample:1" } ] } */ });
Calling the describeTasks operation
var params = { tasks: [ /* required */ 'STRING_VALUE', /* more items */ ], cluster: 'STRING_VALUE', include: [ TAGS, /* more items */ ] }; ecs.describeTasks(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.
tasks
— (Array<String>
)A list of up to 100 task IDs or full ARN entries.
include
— (Array<String>
)Specifies whether you want to see the resource tags for the task. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:tasks
— (Array<map>
)The list of tasks.
attachments
— (Array<map>
)The Elastic Network Adapter that's associated with the task if the task uses the
awsvpc
network mode.id
— (String
)The unique identifier for the attachment.
type
— (String
)The type of the attachment, such as
ElasticNetworkInterface
,Service Connect
, andAmazonElasticBlockStorage
.status
— (String
)The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
,DELETED
, andFAILED
.details
— (Array<map>
)Details of the attachment.
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
For Service Connect services, this includes
portName
,clientAliases
,discoveryName
, andingressPortOverride
.For Elastic Block Storage, this includes
roleArn
,deleteOnTermination
,volumeName
,volumeId
, andstatusReason
(only when the attachment fails to create or attach).name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
attributes
— (Array<map>
)The attributes of the task
name
— required — (String
)The name of the attribute. The
name
must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).value
— (String
)The value of the attribute. The
value
must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.targetType
— (String
)The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
Possible values include:"container-instance"
targetId
— (String
)The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
availabilityZone
— (String
)The Availability Zone for the task.
capacityProviderName
— (String
)The capacity provider that's associated with the task.
clusterArn
— (String
)The ARN of the cluster that hosts the task.
connectivity
— (String
)The connectivity status of a task.
Possible values include:"CONNECTED"
"DISCONNECTED"
connectivityAt
— (Date
)The Unix timestamp for the time when the task last went into
CONNECTED
status.containerInstanceArn
— (String
)The ARN of the container instances that host the task.
containers
— (Array<map>
)The containers that's associated with the task.
containerArn
— (String
)The Amazon Resource Name (ARN) of the container.
taskArn
— (String
)The ARN of the task.
name
— (String
)The name of the container.
image
— (String
)The image used for the container.
imageDigest
— (String
)The container image manifest digest.
runtimeId
— (String
)The ID of the Docker container.
lastStatus
— (String
)The last known status of the container.
exitCode
— (Integer
)The exit code returned from the container.
reason
— (String
)A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings
— (Array<map>
)The network bindings associated with the container.
bindIP
— (String
)The IP address that the container is bound to on the container instance.
containerPort
— (Integer
)The port number on the container that's used with the network binding.
hostPort
— (Integer
)The port number on the host that's used with the network binding.
protocol
— (String
)The protocol used for the network binding.
Possible values include:"tcp"
"udp"
containerPortRange
— (String
)The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a
containerPortRange
:-
You must use either the
bridge
network mode or theawsvpc
network mode. -
This parameter is available for both the EC2 and Fargate launch types.
-
This parameter is available for both the Linux and Windows operating systems.
-
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the
ecs-init
package -
You can specify a maximum of 100 port ranges per container.
-
You do not specify a
hostPortRange
. The value of thehostPortRange
is set as follows:-
For containers in a task with the
awsvpc
network mode, thehostPortRange
is set to the same value as thecontainerPortRange
. This is a static mapping strategy. -
For containers in a task with the
bridge
network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
-
-
The
containerPortRange
valid values are between 1 and 65535. -
A port can only be included in one port mapping per container.
-
You cannot specify overlapping port ranges.
-
The first port in the range must be less than last port in the range.
-
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view thehostPortRange
which are the host ports that are bound to the container ports.-
hostPortRange
— (String
)The 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.
networkInterfaces
— (Array<map>
)The network interfaces associated with the container.
attachmentId
— (String
)The attachment ID for the network interface.
privateIpv4Address
— (String
)The private IPv4 address for the network interface.
ipv6Address
— (String
)The private IPv6 address for the network interface.
healthStatus
— (String
)The 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
Possible values include:UNKNOWN
."HEALTHY"
"UNHEALTHY"
"UNKNOWN"
managedAgents
— (Array<map>
)The details of any Amazon ECS managed agents associated with the container.
lastStartedAt
— (Date
)The Unix timestamp for the time when the managed agent was last started.
name
— (String
)The name of the managed agent. When the execute command feature is turned on, the managed agent name is
Possible values include:ExecuteCommandAgent
."ExecuteCommandAgent"
reason
— (String
)The reason for why the managed agent is in the state it is in.
lastStatus
— (String
)The last known status of the managed agent.
cpu
— (String
)The 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.memory
— (String
)The hard limit (in MiB) of memory set for the container.
memoryReservation
— (String
)The soft limit (in MiB) of memory set for the container.
gpuIds
— (Array<String>
)The IDs of each GPU assigned to the container.
cpu
— (String
)The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example,
1024
). It can also be expressed as a string using vCPUs (for example,1 vCPU
or1 vcpu
). String values are converted to an integer that indicates the CPU units when the task definition is registered.If you use the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the
memory
parameter:The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
-
256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) -
512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) -
1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) -
2048 (2 vCPU) - Available
memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
4096 (4 vCPU) - Available
memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
8192 (8 vCPU) - Available
memory
values: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0
or later. -
16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0
or later.
-
createdAt
— (Date
)The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the
PENDING
state.desiredStatus
— (String
)The desired status of the task. For more information, see Task Lifecycle.
enableExecuteCommand
— (Boolean
)Determines whether execute command functionality is turned on for this task. If
true
, execute command functionality is turned on all the containers in the task.executionStoppedAt
— (Date
)The Unix timestamp for the time when the task execution stopped.
group
— (String
)The name of the task group that's associated with the task.
healthStatus
— (String
)The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as
HEALTHY
, the task status also reports asHEALTHY
. If any essential containers in the task are reporting asUNHEALTHY
orUNKNOWN
, the task status also reports asUNHEALTHY
orUNKNOWN
.Note: The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.Possible values include:"HEALTHY"
"UNHEALTHY"
"UNKNOWN"
inferenceAccelerators
— (Array<map>
)The Elastic Inference accelerator that's associated with the task.
deviceName
— required — (String
)The Elastic Inference accelerator device name. The
deviceName
must also be referenced in a container definition as a ResourceRequirement.deviceType
— required — (String
)The Elastic Inference accelerator type to use.
lastStatus
— (String
)The last known status for the task. For more information, see Task Lifecycle.
launchType
— (String
)The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
memory
— (String
)The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example,
1024
). If it's expressed as a string using GB (for example,1GB
or1 GB
), it's converted to an integer indicating the MiB when the task definition is registered.If you use the EC2 launch type, this field is optional.
If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the
cpu
parameter.-
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) -
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) -
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) -
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpu
values: 2048 (2 vCPU) -
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpu
values: 4096 (4 vCPU) -
Between 16 GB and 60 GB in 4 GB increments - Available
cpu
values: 8192 (8 vCPU)This option requires Linux platform
1.4.0
or later. -
Between 32GB and 120 GB in 8 GB increments - Available
cpu
values: 16384 (16 vCPU)This option requires Linux platform
1.4.0
or later.
-
overrides
— (map
)One or more container overrides.
containerOverrides
— (Array<map>
)One or more container overrides that are sent to a task.
name
— (String
)The name of the container that receives the override. This parameter is required if any override is specified.
command
— (Array<String>
)The 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.
environment
— (Array<map>
)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. You must also specify a container name.
name
— (String
)The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
— (String
)The value of the key-value pair. For environment variables, this is the value of the environment variable.
environmentFiles
— (Array<map>
)A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
value
— required — (String
)The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type
— required — (String
)The file type to use. Environment files are objects in Amazon S3. The only supported value is
Possible values include:s3
."s3"
cpu
— (Integer
)The number of
cpu
units reserved for the container, instead of the default value from the task definition. You must also specify a container name.memory
— (Integer
)The 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.
memoryReservation
— (Integer
)The 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.
resourceRequirements
— (Array<map>
)The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
value
— required — (String
)The value for the specified resource type.
When the type is
GPU
, the value is the number of physicalGPUs
the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.When the type is
InferenceAccelerator
, thevalue
matches thedeviceName
for an InferenceAccelerator specified in a task definition.type
— required — (String
)The type of resource to assign to a container.
Possible values include:"GPU"
"InferenceAccelerator"
cpu
— (String
)The CPU override for the task.
inferenceAcceleratorOverrides
— (Array<map>
)The Elastic Inference accelerator override for the task.
deviceName
— (String
)The Elastic Inference accelerator device name to override for the task. This parameter must match a
deviceName
specified in the task definition.deviceType
— (String
)The Elastic Inference accelerator type to use.
executionRoleArn
— (String
)The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
memory
— (String
)The memory override for the task.
taskRoleArn
— (String
)The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.
ephemeralStorage
— (map
)The ephemeral storage setting override for the task.
Note: This parameter is only supported for tasks hosted on Fargate that use the following platform versions:- Linux platform version
1.4.0
or later. - Windows platform version
1.0.0
or later.
sizeInGiB
— required — (Integer
)The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
20
GiB and the maximum supported value is200
GiB.
- Linux platform version
platformVersion
— (String
)The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the
LATEST
platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.platformFamily
— (String
)The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily
value as the service (for example,LINUX.
).pullStartedAt
— (Date
)The Unix timestamp for the time when the container image pull began.
pullStoppedAt
— (Date
)The Unix timestamp for the time when the container image pull completed.
startedAt
— (Date
)The 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 theRUNNING
state.startedBy
— (String
)The 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.stopCode
— (String
)The stop code indicating why a task was stopped. The
stoppedReason
might contain additional details.For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.
Possible values include:"TaskFailedToStart"
"EssentialContainerExited"
"UserInitiated"
"ServiceSchedulerInitiated"
"SpotInterruption"
"TerminationNotice"
stoppedAt
— (Date
)The 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 theSTOPPED
state.stoppedReason
— (String
)The reason that the task was stopped.
stoppingAt
— (Date
)The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the
RUNNING
state toSTOPPING
.tags
— (Array<map>
)The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
taskArn
— (String
)The Amazon Resource Name (ARN) of the task.
taskDefinitionArn
— (String
)The ARN of the task definition that creates the task.
version
— (Integer
)The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the
detail
object) to verify that the version in your event stream is current.ephemeralStorage
— (map
)The ephemeral storage settings for the task.
sizeInGiB
— required — (Integer
)The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
20
GiB and the maximum supported value is200
GiB.
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the task.
sizeInGiB
— (Integer
)The total amount, in GiB, of the ephemeral storage to set for the task. The minimum supported value is
20
GiB and the maximum supported value is200
GiB.kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeTaskSets(params = {}, callback) ⇒ AWS.Request
Describes the task sets in the specified cluster and service. This is used when a service uses the
EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.Service Reference:
Examples:
Calling the describeTaskSets operation
var params = { cluster: 'STRING_VALUE', /* required */ service: 'STRING_VALUE', /* required */ include: [ TAGS, /* more items */ ], taskSets: [ 'STRING_VALUE', /* more items */ ] }; ecs.describeTaskSets(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
service
— (String
)The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
taskSets
— (Array<String>
)The ID or full Amazon Resource Name (ARN) of task sets to describe.
include
— (Array<String>
)Specifies whether to see the resource tags for the task set. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:taskSets
— (Array<map>
)The list of task sets described.
id
— (String
)The ID of the task set.
taskSetArn
— (String
)The Amazon Resource Name (ARN) of the task set.
serviceArn
— (String
)The Amazon Resource Name (ARN) of the service the task set exists in.
clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
startedBy
— (String
)The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
startedBy
parameter isCODE_DEPLOY
. If an external deployment created the task set, thestartedBy
field isn't used.externalId
— (String
)The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the
externalId
parameter contains the CodeDeploy deployment ID.If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains theECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute.status
— (String
)The status of the task set. The following describes each state.
- PRIMARY
-
The task set is serving production traffic.
- ACTIVE
-
The task set isn't serving production traffic.
- DRAINING
-
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
taskDefinition
— (String
)The task definition that the task set is using.
computedDesiredCount
— (Integer
)The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.pendingCount
— (Integer
)The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it's restarted after being in theSTOPPED
state.runningCount
— (Integer
)The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.createdAt
— (Date
)The Unix timestamp for the time when the task set was created.
updatedAt
— (Date
)The Unix timestamp for the time when the task set was last updated.
launchType
— (String
)The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
Possible values include:"EC2"
"FARGATE"
"EXTERNAL"
capacityProviderStrategy
— (Array<map>
)The capacity provider strategy that are associated with the task set.
capacityProvider
— required — (String
)The short name of the capacity provider.
weight
— (Integer
)The 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 thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.base
— (Integer
)The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
platformVersion
— (String
)The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
platformFamily
— (String
)The 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.
All tasks in the set must have the same value.
networkConfiguration
— (map
)The network configuration for the task set.
awsvpcConfiguration
— (map
)The VPC subnets and security groups that are associated with a task.
Note: All specified subnets and security groups must be from the same VPC.subnets
— required — (Array<String>
)The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per
awsvpcConfiguration
.Note: All specified subnets must be from the same VPC.securityGroups
— (Array<String>
)The 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 per
awsvpcConfiguration
.Note: All specified security groups must be from the same VPC.assignPublicIp
— (String
)Whether the task's elastic network interface receives a public IP address. The default value is
Possible values include:DISABLED
."ENABLED"
"DISABLED"
loadBalancers
— (Array<map>
)Details on a load balancer that are used with a task set.
targetGroupArn
— (String
)The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.loadBalancerName
— (String
)The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName
— (String
)The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort
— (Integer
)The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.
serviceRegistries
— (Array<map>
)The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
registryArn
— (String
)The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port
— (Integer
)The port value used if your service discovery service specified an SRV record. This field might be used if both the
awsvpc
network mode and SRV records are used.containerName
— (String
)The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.containerPort
— (Integer
)The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can't specify both.
scale
— (map
)A floating-point percentage of your desired number of tasks to place and keep running in the task set.
value
— (Float
)The value, specified as a percent total of a service's
desiredCount
, to scale the task set. Accepted values are numbers between 0 and 100.unit
— (String
)The unit of measure for the scale value.
Possible values include:"PERCENT"
stabilityStatus
— (String
)The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks that are running on container instances in the
DRAINING
status. -
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
Possible values include:STABILIZING
."STEADY_STATE"
"STABILIZING"
-
stabilityStatusAt
— (Date
)The Unix timestamp for the time when the task set stability status was retrieved.
tags
— (Array<map>
)The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key
— (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
fargateEphemeralStorage
— (map
)The Fargate ephemeral storage settings for the task set.
kmsKeyId
— (String
)Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
-
(AWS.Response)
—
Returns:
discoverPollEndpoint(params = {}, callback) ⇒ AWS.Request
Note: This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.Returns an endpoint for the Amazon ECS agent to poll for updates.
Service Reference:
Examples:
Calling the discoverPollEndpoint operation
var params = { cluster: 'STRING_VALUE', containerInstance: 'STRING_VALUE' }; ecs.discoverPollEndpoint(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
containerInstance
— (String
)The container instance ID or full ARN of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:endpoint
— (String
)The endpoint for the Amazon ECS agent to poll.
telemetryEndpoint
— (String
)The telemetry endpoint for the Amazon ECS agent.
serviceConnectEndpoint
— (String
)The endpoint for the Amazon ECS agent to poll for Service Connect configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
-
(AWS.Response)
—
Returns:
executeCommand(params = {}, callback) ⇒ AWS.Request
Runs a command remotely on a container within a task.
If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an
AccessDeniedException
when there is a mismatch between the condition key value and the corresponding parameter value.For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.
Service Reference:
Examples:
Calling the executeCommand operation
var params = { command: 'STRING_VALUE', /* required */ interactive: true || false, /* required */ task: 'STRING_VALUE', /* required */ cluster: 'STRING_VALUE', container: 'STRING_VALUE' }; ecs.executeCommand(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.
container
— (String
)The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.
command
— (String
)The command to run on the container.
interactive
— (Boolean
)Use this flag to run your command in interactive mode.
task
— (String
)The Amazon Resource Name (ARN) or ID of the task the container is part of.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:clusterArn
— (String
)The Amazon Resource Name (ARN) of the cluster.
containerArn
— (String
)The Amazon Resource Name (ARN) of the container.
containerName
— (String
)The name of the container.
interactive
— (Boolean
)Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify
true
for this value.session
— (map
)The details of the SSM session that was created for this instance of execute-command.
sessionId
— (String
)The ID of the execute command session.
streamUrl
— (String
)A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.
tokenValue
— (String
)An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.
taskArn
— (String
)The Amazon Resource Name (ARN) of the task.
-
(AWS.Response)
—
Returns:
getTaskProtection(params = {}, callback) ⇒ AWS.Request
Retrieves the protection status of tasks in an Amazon ECS service.
Service Reference:
Examples:
To get the protection status of a task
/* In this example, we get the protection status for a single task. */ var params = { cluster: "test-task-protection", tasks: [ "b8b1cf532d0e46ba8d44a40d1de16772" ] }; ecs.getTaskProtection(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { failures: [ ], protectedTasks: [ { expirationDate: <Date Representation>, protectionEnabled: true, taskArn: "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772" } ] } */ });
Calling the getTaskProtection operation
var params = { cluster: 'STRING_VALUE', /* required */ tasks: [ 'STRING_VALUE', /* more items */ ] }; ecs.getTaskProtection(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
cluster
— (String
)The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
tasks
— (Array<String>
)A list of up to 100 task IDs or full ARN entries.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:protectedTasks
— (Array<map>
)A list of tasks with the following information.
-
taskArn
: The task ARN. -
protectionEnabled
: The protection status of the task. If scale-in protection is turned on for a task, the value istrue
. Otherwise, it isfalse
. -
expirationDate
: The epoch time when protection for the task will expire.
taskArn
— (String
)The task ARN.
protectionEnabled
— (Boolean
)The protection status of the task. If scale-in protection is on for a task, the value is
true
. Otherwise, it isfalse
.expirationDate
— (Date
)The epoch time when protection for the task will expire.
-
failures
— (Array<map>
)Any failures associated with the call.
arn
— (String
)The Amazon Resource Name (ARN) of the failed resource.
reason
— (String
)The reason for the failure.
detail
— (String
)The details of the failure.
-
(AWS.Response)
—
Returns:
- deleteCluster(params = {}, callback) ⇒ AWS.Request