`prefect_aws.ecs` ¶

DEPRECATION WARNING:

This module is deprecated as of March 2024 and will not be available after September 2024. It has been replaced by the ECS worker, which offers enhanced functionality and better performance.

For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.

Integrations with the Amazon Elastic Container Service.

Examples:

Run a task using ECS Fargate
```python
ECSTask(command=["echo", "hello world"]).run()
```

Run a task using ECS Fargate with a spot container instance
```python
ECSTask(command=["echo", "hello world"], launch_type="FARGATE_SPOT").run()
```

Run a task using ECS with an EC2 container instance
```python
ECSTask(command=["echo", "hello world"], launch_type="EC2").run()
```

Run a task on a specific VPC using ECS Fargate
```python
ECSTask(command=["echo", "hello world"], vpc_id="vpc-01abcdf123456789a").run()
```

Run a task and stream the container's output to the local terminal. Note an
execution role must be provided with permissions: logs:CreateLogStream,
logs:CreateLogGroup, and logs:PutLogEvents.
```python
ECSTask(
    command=["echo", "hello world"],
    stream_output=True,
    execution_role_arn="..."
)
```

Run a task using an existing task definition as a base
```python
ECSTask(command=["echo", "hello world"], task_definition_arn="arn:aws:ecs:...")
```

Run a task with a specific image
```python
ECSTask(command=["echo", "hello world"], image="alpine:latest")
```

Run a task with custom memory and CPU requirements
```python
ECSTask(command=["echo", "hello world"], memory=4096, cpu=2048)
```

Run a task with custom environment variables
```python
ECSTask(command=["echo", "hello $PLANET"], env={"PLANET": "earth"})
```

Run a task in a specific ECS cluster
```python
ECSTask(command=["echo", "hello world"], cluster="my-cluster-name")
```

Run a task with custom VPC subnets
```python
ECSTask(
    command=["echo", "hello world"],
    task_customizations=[
        {
            "op": "add",
            "path": "/networkConfiguration/awsvpcConfiguration/subnets",
            "value": ["subnet-80b6fbcd", "subnet-42a6fdgd"],
        },
    ]
)
```

Run a task without a public IP assigned
```python
ECSTask(
    command=["echo", "hello world"],
    vpc_id="vpc-01abcdf123456789a",
    task_customizations=[
        {
            "op": "replace",
            "path": "/networkConfiguration/awsvpcConfiguration/assignPublicIp",
            "value": "DISABLED",
        },
    ]
)
```

Run a task with custom VPC security groups
```python
ECSTask(
    command=["echo", "hello world"],
    vpc_id="vpc-01abcdf123456789a",
    task_customizations=[
        {
            "op": "add",
            "path": "/networkConfiguration/awsvpcConfiguration/securityGroups",
            "value": ["sg-d72e9599956a084f5"],
        },
    ],
)
```

`ECSTask` ¶

Bases: Infrastructure

Run a command as an ECS task.

Attributes:

Name	Type	Description
`type`	`Literal['ecs-task']`	The slug for this task type with a default value of "ecs-task".
`aws_credentials`	`AwsCredentials`	The AWS credentials to use to connect to ECS with a default factory of AwsCredentials.
`task_definition_arn`	`Optional[str]`	An optional identifier for an existing task definition to use. If fields are set on the ECSTask that conflict with the task definition, a new copy will be registered with the required values. Cannot be used with task_definition. If not provided, Prefect will generate and register a minimal task definition.
`task_definition`	`Optional[dict]`	An optional ECS task definition to use. Prefect may set defaults or override fields on this task definition to match other ECSTask fields. Cannot be used with task_definition_arn. If not provided, Prefect will generate and register a minimal task definition.
`family`	`Optional[str]`	An optional family for the task definition. If not provided, it will be inferred from the task definition. If the task definition does not have a family, the name will be generated. When flow and deployment metadata is available, the generated name will include their names. Values for this field will be slugified to match AWS character requirements.
`image`	`Optional[str]`	An optional image to use for the Prefect container in the task. If this value is not null, it will override the value in the task definition. This value defaults to a Prefect base image matching your local versions.
`auto_deregister_task_definition`	`bool`	A boolean that controls if any task definitions that are created by this block will be deregistered or not. Existing task definitions linked by ARN will never be deregistered. Deregistering a task definition does not remove it from your AWS account, instead it will be marked as INACTIVE.
`cpu`	`int`	The amount of CPU to provide to the ECS task. Valid amounts are specified in the AWS documentation. If not provided, a default value of ECS_DEFAULT_CPU will be used unless present on the task definition.
`memory`	`int`	The amount of memory to provide to the ECS task. Valid amounts are specified in the AWS documentation. If not provided, a default value of ECS_DEFAULT_MEMORY will be used unless present on the task definition.
`execution_role_arn`	`str`	An execution role to use for the task. This controls the permissions of the task when it is launching. If this value is not null, it will override the value in the task definition. An execution role must be provided to capture logs from the container.
`configure_cloudwatch_logs`	`bool`	A boolean that controls if the Prefect container will be configured to send its output to the AWS CloudWatch logs service or not. This functionality requires an execution role with permissions to create log streams and groups.
`cloudwatch_logs_options`	`Dict[str, str]`	A dictionary of options to pass to the CloudWatch logs configuration.
`stream_output`	`bool`	A boolean indicating whether logs will be streamed from the Prefect container to the local console.
`launch_type`	`Optional[Literal['FARGATE', 'EC2', 'EXTERNAL', 'FARGATE_SPOT']]`	An optional launch type for the ECS task run infrastructure.
`vpc_id`	`Optional[str]`	An optional VPC ID to link the task run to. This is only applicable when using the 'awsvpc' network mode for your task.
`cluster`	`Optional[str]`	An optional ECS cluster to run the task in. The ARN or name may be provided. If not provided, the default cluster will be used.
`env`	`Dict[str, Optional[str]]`	A dictionary of environment variables to provide to the task run. These variables are set on the Prefect container at task runtime.
`task_role_arn`	`str`	An optional role to attach to the task run. This controls the permissions of the task while it is running.
`task_customizations`	`JsonPatch`	A list of JSON 6902 patches to apply to the task run request. If a string is given, it will parsed as a JSON expression.
`task_start_timeout_seconds`	`int`	The amount of time to watch for the start of the ECS task before marking it as failed. The task must enter a RUNNING state to be considered started.
`task_watch_poll_interval`	`float`	The amount of time to wait between AWS API calls while monitoring the state of an ECS task.