Contents

---
title: Ufo Task Params
nav_order: 24
---

You can run one off task with the [ufo task](https://ufoships.com/reference/ufo-task/) command.

The `ufo task` commands:

1. Builds the docker image
2. Registers the ECS task definition
3. Runs the command


The params that ufo sends to the [ruby aws-sdk](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method) methods to for the one off task can be customized with a `params.yml` file.  This allows you use the full power of the aws-sdk.

A starter project `.ufo/params.yml` file is generated as part of the `ufo init` command. Let's take a look at an example `params.yml`:

```yaml
# These params are passsed to the corresponding aws-sdk ecs client methods.
# AWS Docs example: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method
#
# The network helper provides access to the .ufo/settings/network/[PROFILE].yml
#
# More docs: http://ufoships.com/docs/params/

# ufo task calls run_tasks
run_task:
  # network_configuration is required for FARGATE
  network_configuration:
    awsvpc_configuration:
      subnets: <%= network[:ecs_subnets].inspect %> # required
      security_groups: <%= network[:ecs_security_groups].inspect %>
      assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
```

Ufo provides 1st class citizen access to adjust the params sent to the aws-sdk calls:

ERB and [shared variables]({% link _docs/variables.md %}) are available in the params file.  You can also define the subnets in your config/variables and use them in them in the params.yml file.

Note, the params.yml file does not have access to the `task_definition_name` helper method. That is only available in the `task_definitions.rb` template_definition code blocks.

{% include prev_next.md %}

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
ufo-5.0.0	docs/_docs/ufo-task-params.md
ufo-4.6.3	docs/_docs/ufo-task-params.md
ufo-4.6.2	docs/_docs/ufo-task-params.md
ufo-4.6.1	docs/_docs/ufo-task-params.md
ufo-4.6.0	docs/_docs/ufo-task-params.md