---
description: >-
  The preparations required to deploy Datafold in your own Amazon Web Services
  (AWS) Account
---

# AWS

### Domain name

Create a DNS A-record for the domain (for example, datafold.domain.tld) where Datafold is going to be hosted. For the DNS record there are two options:

* **Public-facing** When the domain is publicly available, we will provide an SSL certificate for the endpoint.
* **Internal** It is also possible to have Datafold disconnected from the internet. This would require an internal DNS (for example, AWS Route 53) record that points to the Datafold instance. It is possible to provide your own certificate for setting up the SSL connection.

Once the deployment is complete, you will point that A-record to the IP address of the Datafold service.

### Allow Datafold access to the AWS Account

For setting up Datafold, it is required to set up a separate account within your organization where we can deploy Datafold. We're following the [best practices of AWS to allow third-party access](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html).

#### Create a separate AWS account for Datafold

First, create a new account for Datafold. Go to My Organization to add an account to the organization:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvCiKupK1xU8r6f69K%2Fimage.png?alt=media\&token=67221874-df04-425f-a349-0291b6e00071)

Add an AWS Account:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvCxr42b8HOZEhyVrd%2Fimage.png?alt=media\&token=d734756a-5a9a-4f47-a93a-bf2c071041fa)

We call the account name "Datafold". Make sure that the email address of the owner isn't used by another account.

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvD8nuSItuvZNDiCip%2Fimage.png?alt=media\&token=b3fa0a2b-fa8b-4685-b1d5-2e2b4a94230a)

When you hit the "Create AWS Account" button, you'll be returned back the organization screen, and see the notification that the new account is being created. After you refresh a couple of times, the account should appear in the list:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvE18C7wkkaeaHu4NV%2Fimage.png?alt=media\&token=1a553304-b7a5-4c3d-874a-bd0daa0fdb7b)

#### Grant Third-Party access to Datafold

To make sure that deployment runs as expected, your Datafold Customer Engineer may need access to the Datafold-specific AWS account that you created. The access can be revoked after the deployment if needed. To grant access, log into the account created in the previous step. You can switch to the newly created account using the [Switch Role page](https://signin.aws.amazon.com/switchrole):

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvFPSHSDgJMntBexyu%2Fimage.png?alt=media\&token=0a607ad1-7aca-4844-894f-c160c1a05712)

By default the role name is **OrganizationAccountAccessRole**.

Now you're logged in into the Account of Datafold:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvFmQDY4xSd19eBsjD%2Fimage.png?alt=media\&token=8f90ceff-8ad4-46c9-aa46-286ec481f7c7)

#### Grant Access to Datafold

Next, we need to allow Datafold to access the account. We do this by allowing the Datafold AWS account to access your AWS workspace. Go to the [IAM page](https://console.aws.amazon.com/iam/home) to add a role:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvGuTxvvNyMz9VE6AM%2Fimage.png?alt=media\&token=672fcb74-4f77-4feb-a135-a4e2186dc092)

Go to the Roles page, and hit Create role:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvHSMXtyeTYA6GJym0%2Fimage.png?alt=media\&token=f1902b50-2a6f-4d1f-8ddd-7b2c3d69b858)

Select Another AWS Account, and use account ID **710753145501** which is the one of Datafold. Make sure to Require MFA.

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvKl1veBmFZqY9U_fg%2Fimage.png?alt=media\&token=8aafb3a0-5348-47ae-8498-6deba95374da)

Let's get back to the previous tab, and make sure to select **AdministratorAccess** gives us control over the resources within the account.

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-McYCkvnHznQ7SONw6ei%2F-McYDI2j97HpvLD0kwAz%2Fimage.png?alt=media\&token=d11e4d5b-b5c2-4406-8572-10d4b0124b43)

Next, you can set Tags; however, they are not a requirement.&#x20;

Finally, give the role a name of your choice and in line with your organization's naming conventions. Avoid calling it "Datafold" as in the pictures below:&#x20;

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvSzuZztdp3t5cblt_%2Fimage.png?alt=media\&token=980ca998-adc2-4614-90c9-3abc46d75e4d)

Now the role is created, which marks Datafold as a trusted entity:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MW5oouougFyPvHgESLi%2F-MbuSsqN5rr-A1ptTnvW%2F-MbvT2SwV3Sfa-Wn2NEx%2Fimage.png?alt=media\&token=31fe28cd-e9c2-45d6-9887-22291700c694)

Please provide the link referenced in"_Give this link to users who can switch roles in the console"_  to Datafold:

![](https://987627956-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MW5oouougFyPvHgESLi%2Fuploads%2FSwdk2klJyw2j2dolJxHP%2Fimage.png?alt=media\&token=ce5ae605-8ce2-4eb7-b891-0adab1573961)

That's is, and we'll take it from there. After validating the deployment, and making sure that everything works as it should, we can revoke the credentials.
