aws-native.ecs.DaemonTaskDefinition

The details of a daemon task definition. A daemon task definition is a template that describes the containers that form a daemon. Daemons deploy cross-cutting software agents independently across your Amazon ECS infrastructure.

Create DaemonTaskDefinition Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DaemonTaskDefinition(name: string, args?: DaemonTaskDefinitionArgs, opts?: CustomResourceOptions);

@overload
def DaemonTaskDefinition(resource_name: str,
                         args: Optional[DaemonTaskDefinitionArgs] = None,
                         opts: Optional[ResourceOptions] = None)

@overload
def DaemonTaskDefinition(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         container_definitions: Optional[Sequence[DaemonTaskDefinitionDaemonContainerDefinitionArgs]] = None,
                         cpu: Optional[str] = None,
                         execution_role_arn: Optional[str] = None,
                         family: Optional[str] = None,
                         memory: Optional[str] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                         task_role_arn: Optional[str] = None,
                         volumes: Optional[Sequence[DaemonTaskDefinitionVolumeArgs]] = None)

func NewDaemonTaskDefinition(ctx *Context, name string, args *DaemonTaskDefinitionArgs, opts ...ResourceOption) (*DaemonTaskDefinition, error)

public DaemonTaskDefinition(string name, DaemonTaskDefinitionArgs? args = null, CustomResourceOptions? opts = null)

public DaemonTaskDefinition(String name, DaemonTaskDefinitionArgs args)
public DaemonTaskDefinition(String name, DaemonTaskDefinitionArgs args, CustomResourceOptions options)

type: aws-native:ecs:DaemonTaskDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

DaemonTaskDefinition Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DaemonTaskDefinition resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the DaemonTaskDefinition resource produces the following output properties:

Supporting Types

DaemonTaskDefinitionContainerDependency, DaemonTaskDefinitionContainerDependencyArgs

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use 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 version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide. For tasks that use 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 more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.

DaemonTaskDefinitionDaemonContainerDefinition, DaemonTaskDefinitionDaemonContainerDefinitionArgs

DaemonTaskDefinitionDevice, DaemonTaskDefinitionDeviceArgs

DaemonTaskDefinitionEnvironmentFile, DaemonTaskDefinitionEnvironmentFileArgs

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=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 Use a file to pass environment variables to a container in the Amazon Elastic Container Service Developer Guide. Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply. You must use the following platforms for the Fargate launch type:

• Linux platform version 1.4.0 or later.
• Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

• The file is handled like a native Docker env-file.
• There is no support for shell escape handling.
• The container entry point interperts the VARIABLE values.

DaemonTaskDefinitionFirelensConfiguration, DaemonTaskDefinitionFirelensConfigurationArgs

DaemonTaskDefinitionHealthCheck, DaemonTaskDefinitionHealthCheckArgs

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the HEALTHCHECK parameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console. The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability. Amazon ECS performs health checks on containers with the default that launched the container instance or the task. The following describes the possible healthStatus values for a container:

• HEALTHY-The container health check has passed successfully.
• UNHEALTHY-The container health check has failed.
• UNKNOWN-The container health check is being evaluated, there's no container health check defined, or Amazon ECS doesn't have the health status of the container.

The following describes the possible healthStatus values based on the container health checker status of essential containers in the task with the following priority order (high to low):

• UNHEALTHY-One or more essential containers have failed their health check.
• UNKNOWN-Any essential container running within the task is in an UNKNOWN state and no other essential containers have an UNHEALTHY state.
• HEALTHY-All essential containers within the task have passed their health checks.

Consider the following task health example with 2 containers.

• If Container1 is UNHEALTHY and Container2 is UNKNOWN, the task health is UNHEALTHY.
• If Container1 is UNHEALTHY and Container2 is HEALTHY, the task health is UNHEALTHY.
• If Container1 is HEALTHY and Container2 is UNKNOWN, the task health is UNKNOWN.
• If Container1 is HEALTHY and Container2 is HEALTHY, the task health is HEALTHY.

Consider the following task health example with 3 containers.

• If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNHEALTHY.
• If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNHEALTHY.
• If Container1 is UNHEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is UNHEALTHY.
• If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNKNOWN.
• If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNKNOWN.
• If Container1 is HEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is HEALTHY.

If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. When a container health check fails for a task that is part of a service, the following process occurs:

1. The task is marked as UNHEALTHY.
2. The unhealthy task will be stopped, and during the stopping process, it will go through the following states:

• DEACTIVATING - In this state, Amazon ECS performs additional steps before stopping the task. For example, for tasks that are part of services configured to use Elastic Load Balancing target groups, target groups will be deregistered in this state.
• STOPPING - The task is in the process of being stopped.
• DEPROVISIONING - Resources associated with the task are being cleaned up.
• STOPPED - The task has been completely stopped.

1. After the old task stops, a new task will be launched to ensure service operation, and the new task will go through the following lifecycle:

• PROVISIONING - Resources required for the task are being provisioned.
• PENDING - The task is waiting to be placed on a container instance.
• ACTIVATING - In this state, Amazon ECS pulls container images, creates containers, configures task networking, registers load balancer target groups, and configures service discovery status.
• RUNNING - The task is running and performing its work.

For more detailed information about task lifecycle states, see Task lifecycle in the Amazon Elastic Container Service Developer Guide. The following are notes about container health check support:

• If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't cause a container to transition to an UNHEALTHY status. This is by design, to ensure that containers remain running during agent restarts or temporary unavailability. The health check status is the "last heard from" response from the Amazon ECS agent, so if the container was considered HEALTHY prior to the disconnect, that status will remain until the agent reconnects and another health check occurs. There are no assumptions made about the status of the container health checks.
• Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS container agent.
• Container health checks are supported for Fargate tasks if you're using platform version 1.1.0 or greater. For more information, see platform versions.
• Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.

For an example of how to specify a task definition with multiple containers where container dependency is specified, see Container dependency in the Amazon Elastic Container Service Developer Guide.

DaemonTaskDefinitionHostVolumeProperties, DaemonTaskDefinitionHostVolumePropertiesArgs

DaemonTaskDefinitionKernelCapabilities, DaemonTaskDefinitionKernelCapabilitiesArgs

• When the container is a privleged container, the container capabilities are all of the default Docker capabilities. The capabilities specified in the add request parameter, and the drop request parameter are ignored.
• When the add request parameter is set to ALL, the container capabilities are all of the default Docker capabilities, excluding those specified in the drop request parameter.
• When the drop request parameter is set to ALL, the container capabilities are the capabilities specified in the add request parameter.
• When the add request parameter and the drop request parameter are both empty, the capabilities the container capabilities are all of the default Docker capabilities.
• The default is to first drop the capabilities specified in the drop request parameter, and then add the capabilities specified in the add request parameter.

DaemonTaskDefinitionKeyValuePair, DaemonTaskDefinitionKeyValuePairArgs

DaemonTaskDefinitionLinuxParameters, DaemonTaskDefinitionLinuxParametersArgs

DaemonTaskDefinitionLogConfiguration, DaemonTaskDefinitionLogConfigurationArgs

• 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 FARGATElong, the supported log drivers are awslogs, splunk, and awsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald,syslog, splunk, and awsfirelens.
• 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 FARGATElong, 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.

DaemonTaskDefinitionMountPoint, DaemonTaskDefinitionMountPointArgs

DaemonTaskDefinitionRepositoryCredentials, DaemonTaskDefinitionRepositoryCredentialsArgs

DaemonTaskDefinitionRestartPolicy, DaemonTaskDefinitionRestartPolicyArgs

DaemonTaskDefinitionSecret, DaemonTaskDefinitionSecretArgs

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

• To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
• To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

DaemonTaskDefinitionSystemControl, DaemonTaskDefinitionSystemControlArgs

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections. We don't recommend that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode. Doing this has the following disadvantages:

• For tasks that use the awsvpc network mode including Fargate, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that's started last determines which systemControls take effect.
• For tasks that use the host network mode, the network namespace systemControls aren't supported.

If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see IPC mode.

• For tasks that use the host IPC mode, IPC namespace systemControls aren't supported.
• For tasks that use the task IPC mode, IPC namespace systemControls values apply to all containers within a task.

This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

DaemonTaskDefinitionTmpfs, DaemonTaskDefinitionTmpfsArgs

DaemonTaskDefinitionUlimit, DaemonTaskDefinitionUlimitArgs

DaemonTaskDefinitionVolume, DaemonTaskDefinitionVolumeArgs

Tag, TagArgs

Package Details

Repository

AWS Native pulumi/pulumi-aws-native

License

Apache-2.0