create_daemon¶
Operation¶
async
¶
create_daemon(input: CreateDaemonInput, plugins: list[Plugin] | None = None) -> CreateDaemonOutput
Creates a new daemon in the specified cluster and capacity providers. A daemon deploys cross-cutting software agents such as security monitoring, telemetry, and logging independently across your Amazon ECS infrastructure.
Amazon ECS deploys exactly one daemon task on each container instance of the specified capacity providers. When a container instance registers with the cluster, Amazon ECS automatically starts daemon tasks. Amazon ECS starts a daemon task before scheduling other tasks.
Daemons are essential for instance health - if a daemon task stops, Amazon ECS automatically drains and replaces that container instance.
Note
ECS Managed Daemons is only supported for Amazon ECS Managed Instances Capacity Providers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateDaemonInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateDaemonOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateDaemonInput structure.
Attributes¶
class-attribute
instance-attribute
¶
The Amazon Resource Names (ARNs) of the capacity providers to associate with the daemon. The daemon deploys tasks on container instances managed by these capacity providers.
class-attribute
instance-attribute
¶
client_token: str | None = ...
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.
class-attribute
instance-attribute
¶
cluster_arn: str | None = ...
The Amazon Resource Name (ARN) of the cluster to create the daemon in.
class-attribute
instance-attribute
¶
critical: bool | None = ...
If the critical parameter of a daemon is true, and the daemon task
fails, stops, or becomes unhealthy, Amazon ECS drains the container
instance and stops the other tasks running on it. If the critical
parameter is false, the daemon task failure doesn't affect the other
tasks on the instance. The default value is true.
A non-critical daemon doesn't block instance registration. The container instance becomes active and continues to run your other tasks, whether the daemon task fails during scale-out or during a deployment.
Amazon ECS emits an EventBridge event when a daemon task fails to start, for both critical and non-critical daemons.
Daemon task launch failures during a deployment are still counted by the deployment circuit breaker. The circuit breaker can roll back an unstable target revision.
class-attribute
instance-attribute
¶
daemon_name: str | None = ...
The name of the daemon. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
class-attribute
instance-attribute
¶
daemon_task_definition_arn: str | None = ...
The Amazon Resource Name (ARN) of the daemon task definition to use for the daemon.
class-attribute
instance-attribute
¶
Optional deployment parameters that control how the daemon rolls out updates, including the drain percentage, alarm-based rollback, and bake time.
class-attribute
instance-attribute
¶
enable_ecs_managed_tags: bool = ...
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.
class-attribute
instance-attribute
¶
enable_execute_command: bool = ...
Determines whether the execute command functionality is turned on for
the daemon. If true, the execute command functionality is turned on
for all tasks in the daemon.
class-attribute
instance-attribute
¶
propagate_tags: str | None = ...
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. To add tags to a task after task creation, use the TagResource API action.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = ...
The metadata that you apply to the daemon to help you categorize and organize them. 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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateDaemonOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
The Unix timestamp for the time when the daemon was created.
class-attribute
instance-attribute
¶
daemon_arn: str | None = ...
The Amazon Resource Name (ARN) of the daemon.
class-attribute
instance-attribute
¶
deployment_arn: str | None = ...
The Amazon Resource Name (ARN) of the initial daemon deployment. This deployment places daemon tasks on each container instance of the specified capacity providers.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.