AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ecs ]

update-daemon

Description

Updates the specified daemon. When you update a daemon, a new deployment is triggered that progressively rolls out the changes to the container instances associated with the daemon’s capacity providers. For more information, see Daemon deployments in the Amazon Elastic Container Service Developer Guide .

Amazon ECS drains existing container instances and provisions new instances with the updated daemon. Amazon ECS automatically launches replacement tasks for your services.

Warning

Updating a daemon triggers a rolling deployment that drains and replaces container instances. Plan updates during maintenance windows to minimize impact on running services.

Note

ECS Managed Daemons is only supported for Amazon ECS Managed Instances Capacity Providers.

See also: AWS API Documentation

Synopsis

  update-daemon
--daemon-arn <value>
--daemon-task-definition-arn <value>
--capacity-provider-arns <value>
[--deployment-configuration <value>]
[--propagate-tags <value>]
[--enable-ecs-managed-tags | --no-enable-ecs-managed-tags]
[--enable-execute-command | --disable-execute-command]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--daemon-arn (string)

The Amazon Resource Name (ARN) of the daemon to update.

--daemon-task-definition-arn (string)

The Amazon Resource Name (ARN) of the daemon task definition to use for the updated daemon.

--capacity-provider-arns (list)

The Amazon Resource Names (ARNs) of the capacity providers to associate with the daemon.

(string)

Syntax:

"string" "string" ...

--deployment-configuration (structure)

Optional deployment parameters that control how the daemon rolls out updates, including the drain percentage, alarm-based rollback, and bake time.

drainPercent -> (double)

The percentage of container instances to drain simultaneously during a daemon deployment. Valid values are between 0.0 and 100.0.

alarms -> (structure)

The CloudWatch alarm configuration for the daemon deployment. When alarms are triggered during a deployment, the deployment can be automatically rolled back.

alarmNames -> (list)

The CloudWatch alarm names to monitor during a daemon deployment.

(string)

enable -> (boolean)

Determines whether to use the CloudWatch alarm option in the daemon deployment process. The default value is false .

bakeTimeInMinutes -> (integer)

The amount of time (in minutes) to wait after a successful deployment step before proceeding. This allows time to monitor for issues before continuing. The default value is 0.

Shorthand Syntax:

drainPercent=double,alarms={alarmNames=[string,string],enable=boolean},bakeTimeInMinutes=integer

JSON Syntax:

{
  "drainPercent": double,
  "alarms": {
    "alarmNames": ["string", ...],
    "enable": true|false
  },
  "bakeTimeInMinutes": integer
}

--propagate-tags (string)

Specifies whether to propagate the tags from the daemon to the daemon tasks. If you don’t specify a value, the tags aren’t propagated. You can only propagate tags to daemon tasks during task creation.

Possible values:

  • DAEMON
  • NONE

--enable-ecs-managed-tags | --no-enable-ecs-managed-tags (boolean)

Specifies whether to turn on Amazon ECS managed tags for the tasks in the daemon. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide .

--enable-execute-command | --disable-execute-command (boolean)

If true , the execute command functionality is turned on for all tasks in the daemon. If false , the execute command functionality is turned off.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

daemonArn -> (string)

The Amazon Resource Name (ARN) of the daemon.

status -> (string)

The status of the daemon.

createdAt -> (timestamp)

The Unix timestamp for the time when the daemon was created.

updatedAt -> (timestamp)

The Unix timestamp for the time when the daemon was last updated.

deploymentArn -> (string)

The Amazon Resource Name (ARN) of the daemon deployment that was triggered by the update.