Automatic Setup

You can use the coiled setup aws CLI tool to connect Coiled to your AWS account, which relies on your local AWS credentials:

coiled setup aws

Tip

No local AWS credentials?

If you use AWS as part of a larger organization or company, you may need to contact your admin for access.

For individuals, you can use AWS CloudShell, which already has the AWS CLI installed and configured with your AWS credentials. You can use the --cloudshell-link parameter to print instructions specific to your Coiled workspace:

coiled setup aws --cloudshell-link

With your permission, this command will create the IAM policies and infrastructure Coiled needs so you can create clusters in your AWS account. You will be prompted with an explanation at each step, so you can choose to say “yes” (or “no”) at any point (see Manual Setup for more details).

Here’s a demonstration of the process:

Note

Especially if you are using a new AWS account, you may encounter a LimitExceeded error (e.g. VcpuLimitExceeded). You can view and adjust quota limits using the coiled setup aws --quotas (see Quotas).

coiled setup aws

coiled setup aws [OPTIONS]

Options

--region <region>

AWS region to use for Coiled. By default, this will use the default region configured in your AWS profile if one is configured.

--profile <profile>

AWS profile to use from your local AWS credentials file. By default, uses your [default] profile if one is configured.

--account, --workspace <account>

Coiled workspace that will be configured to use the AWS account. By default, uses your default Coiled workspace. Note: –account is deprecated, please use –workspace instead.

--iam-user <iam_user>

IAM User to create in your AWS account

--setup-policy <setup_policy>

Non-default name for the setup IAM Policy, default {iam-user}-setup

--ongoing-policy <ongoing_policy>

Non-default name for the ongoing IAM Policy, default {iam-user}-ongoing

--update-policies

Only update existing IAM Policies

--update-instance-policy

Update instance policy (not for regular use)

Don’t do setup, give instructions for setup using CloudShell

--use-access-key

Grant Coiled access using access key for an IAM user, rather than using role delegation.

--keep-existing-access

If there’s existing role for role assumption, add to rather than replace trust doc.

--manual-final-setup

Don’t automatically send credentials to Coiled, finish setup manually in the web UI

--quotas

Check and potentially request AWS quota increases for common instance types

-y, --yes

Don’t prompt for confirmation, just do it!

Environment variables

AWS_PROFILE

Provide a default for --profile

previous

AWS

next

Reference