register_daemon_task_definition ¶

def register_daemon_task_definition(
    self,
    family: "capo_ecs.types.string.String",
    container_definitions: "capo_ecs.types.daemon_container_definition_list.DaemonContainerDefinitionList",
    *,
    config_overrides: Optional[ECSClientConfig] = None,
    task_role_arn: Optional["capo_ecs.types.string.String"] = None,
    execution_role_arn: Optional["capo_ecs.types.string.String"] = None,
    cpu: Optional["capo_ecs.types.string.String"] = None,
    memory: Optional["capo_ecs.types.string.String"] = None,
    volumes: Optional["capo_ecs.types.daemon_volume_list.DaemonVolumeList"] = None,
    tags: Optional["capo_ecs.types.tags.Tags"] = None,
    pid_mode: Optional["capo_ecs.types.daemon_pid_mode.DaemonPidMode"] = None,
    ipc_mode: Optional["capo_ecs.types.daemon_ipc_mode.DaemonIpcMode"] = None,
) -> "capo_ecs.types.register_daemon_task_definition_response.RegisterDaemonTaskDefinitionResponse":
    """<p>Registers a new daemon task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/daemon-task-definitions.html">Daemon task definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>A daemon task definition is a template that describes the containers that form a daemon. Daemons deploy cross-cutting software agents such as security monitoring, telemetry, and logging across your Amazon ECS infrastructure.</p> <p>Each time you call <code>RegisterDaemonTaskDefinition</code>, a new revision of the daemon task definition is created. You can't modify a revision after you register it.</p>

    Args:
        family: <p>You must specify a <code>family</code> for a daemon task definition. This family is used as a name for your daemon task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.</p>
        task_role_arn: <p>The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this daemon task can assume. All containers in this daemon task are granted the permissions that are specified in this role.</p>
        execution_role_arn: <p>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. The task execution role is required for daemon tasks that pull container images from Amazon ECR or send container logs to CloudWatch.</p>
        container_definitions: <p>A list of container definitions in JSON format that describe the containers that make up your daemon task.</p>
        cpu: <p>The number of CPU units used by the daemon task. It can be expressed as an integer using CPU units (for example, <code>1024</code>).</p>
        memory: <p>The amount of memory (in MiB) used by the daemon task. It can be expressed as an integer using MiB (for example, <code>1024</code>).</p>
        volumes: <p>A list of volume definitions in JSON format that containers in your daemon task can use.</p>
        tags: <p>The metadata that you apply to the daemon task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>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: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p> </li> </ul>
        pid_mode: <p>The PID namespace mode for the daemon. The valid values are <code>none</code> and <code>shared</code>. The default is <code>none</code>.</p> <p>If <code>none</code> is specified or no value is provided, the daemon runs with its own PID namespace, isolated from other tasks. If <code>shared</code> is specified, the daemon joins the host PID namespace, making it accessible to non-daemon tasks that use <code>pidMode: "host"</code> or other daemons that use <code>pidMode: "shared"</code>.</p>
        ipc_mode: <p>The IPC namespace mode for the daemon. The valid values are <code>none</code> and <code>shared</code>. The default is <code>none</code>.</p> <p>If <code>none</code> is specified or no value is provided, the daemon runs with its own IPC namespace, isolated from other tasks. If <code>shared</code> is specified, the daemon joins the host IPC namespace, making it accessible to non-daemon tasks that use <code>ipcMode: "host"</code> or other daemons that use <code>ipcMode: "shared"</code>.</p>

    Raises:
        capo_ecs.errors.access_denied_exception.AccessDeniedException: <p>You don't have authorization to perform the requested action.</p>
        capo_ecs.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
        capo_ecs.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
        capo_ecs.errors.limit_exceeded_exception.LimitExceededException: <p>The limit for the resource was exceeded.</p>
        capo_ecs.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_ecs.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To register a daemon task definition
        This example registers a daemon task definition in the monitoring-agent family with a single container that runs a CloudWatch agent.

        >>> client.register_daemon_task_definition(family='monitoring-agent', container_definitions=[{'name': 'cloudwatch-agent', 'image': 'public.ecr.aws/cloudwatch-agent/cloudwatch-agent:latest', 'memory': 256, 'cpu': 128, 'essential': True, 'logConfiguration': {'logDriver': 'awslogs', 'options': {'awslogs-group': '/ecs/daemon/monitoring-agent', 'awslogs-region': 'us-east-1', 'awslogs-stream-prefix': 'ecs'}}, 'environment': [{'name': 'USE_DEFAULT_CONFIG', 'value': 'true'}]}], cpu='128', memory='256', execution_role_arn='arn:aws:iam::123456789012:role/ecsTaskExecutionRole', task_role_arn='arn:aws:iam::123456789012:role/ecsDaemonTaskRole')
    """

    def _handler(
        req: "OperationRequest[capo_ecs.types.register_daemon_task_definition_request.RegisterDaemonTaskDefinitionRequest]",
    ) -> OperationResponse[
        "capo_ecs.types.register_daemon_task_definition_response.RegisterDaemonTaskDefinitionResponse"
    ]:
        import capo_ecs._operations.amazon_ec2_container_service_v20141113.register_daemon_task_definition

        output, http_response = (
            capo_ecs._operations.amazon_ec2_container_service_v20141113.register_daemon_task_definition.register_daemon_task_definition(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_ecs.types.register_daemon_task_definition_request.RegisterDaemonTaskDefinitionRequest",
    ) -> dict[str, Any]:
        import capo_ecs.types.register_daemon_task_definition_request

        return (
            capo_ecs.types.register_daemon_task_definition_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "RegisterDaemonTaskDefinition", redact_input=_redact_input
        ),
    )
    input_: capo_ecs.types.register_daemon_task_definition_request.RegisterDaemonTaskDefinitionRequest = {
        "family": family,
        "container_definitions": container_definitions,
    }
    if task_role_arn is not None:
        input_["task_role_arn"] = task_role_arn
    if execution_role_arn is not None:
        input_["execution_role_arn"] = execution_role_arn
    if cpu is not None:
        input_["cpu"] = cpu
    if memory is not None:
        input_["memory"] = memory
    if volumes is not None:
        input_["volumes"] = volumes
    if tags is not None:
        input_["tags"] = tags
    if pid_mode is not None:
        input_["pid_mode"] = pid_mode
    if ipc_mode is not None:
        input_["ipc_mode"] = ipc_mode

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output