Connecting an AWS account gives Clumio the IAM role and resources that it needs to inventory, back up, and restore your data. You start every method from AWS > Connect > Add accounts.
Choose a method
| Method | Use it when |
|---|---|
| CloudFormation | You're connecting one account and can sign in to it. |
| AWS Organizations | You're connecting many accounts in an AWS organization at once. |
| Terraform | You manage AWS infrastructure as code. |
| Manual | Your security team must create the IAM roles and policies themselves. |
Connection settings
In the portal wizards, you choose the following settings. With Terraform, you set the same things in your Terraform configuration instead.
| Setting | Details |
|---|---|
| AWS account ID and regions | The 12-digit account ID and the regions to protect: one or more regions with CloudFormation, or one region per connection when you connect manually. Only supported regions are listed. If a region that you need isn't listed, contact Clumio support. To connect another region later, connect the same account again and select that region. |
| AWS organization ID | For connecting through AWS Organizations only, in place of the account ID and regions. The organization ID starts with o-. You choose the accounts and regions later, when you deploy the StackSet in AWS. The regions must still be supported regions. |
| Asset types | The AWS services to protect. All are selected by default. You can add asset types later, but you can't remove them. |
| Permissions | Inventory and backup is always required. Restore is optional. To leave it out, select Customize permissions. To see every resource and IAM permission that the template creates, select View permissions or Download sample template. |
For the full list of IAM permissions, see Permissions to deploy Clumio on AWS. For what each role and policy that Clumio creates is for, see Clumio IAM roles and policies.
Connect with CloudFormation
-
Sign in to the AWS account that you want to connect.
-
In Clumio, go to AWS > Connect and select Add accounts > Add an account with CloudFormation.
-
On Enter account info, enter the account ID, regions, asset types, and permissions. Select Next.
-
On Choose stack deploy location, select the region for the base stack. Any region works. Select Next.
-
On Create stackset, select Launch stack wizard and complete the CloudFormation wizard in AWS.
The wizard creates the base stack in the region that you chose. The base stack then uses CloudFormation StackSets to deploy the Clumio template to every region that you selected, so one deployment covers all of them.
To deploy the template yourself instead, expand Show template details and copy the template S3 URI, Clumio token, and RoleExternalID.
-
When the stack finishes, return to Clumio and select Done.
The account appears in the AWS > Connect table. Connection status shows Connecting... until Clumio reaches the account, and then Connected.
Connect with AWS Organizations
Clumio gives you a StackSet template that you deploy from your AWS management account. The template creates the IAM roles, policies, and event rules in each target account and region, and registers those accounts with Clumio.
Before you start, make sure that:
-
AWS Organizations is enabled, and StackSets is set up for organization-wide deployments, with trusted access enabled.
-
You can sign in to the management account, or to a delegated administrator account that can deploy StackSets.
For information about trusted access, see Enable trusted access with AWS Organizations.
-
In Clumio, go to AWS > Connect and select Add accounts > Add accounts via Organization.
-
On Enter Organization ID, enter the organization ID, asset types, and permissions. Select Next.
-
On Configure Access in AWS, copy the Role external ID and Connection Token, and select Download template. Leave the wizard open.
-
In the AWS console, go to CloudFormation > StackSets > Create StackSet and create a StackSet from the template with service-managed permissions:
-
Enter the Connection Token as
ClumioTokenand the Role external ID asRoleExternalId. The other parameters are optional. -
Acknowledge that the template creates IAM resources.
-
Set the deployment targets to choose which accounts get the integration: the whole organization, specific organizational units, or specific accounts. To narrow an organizational unit down, add an account filter that limits it to, or excludes, the accounts that you list.
-
Choose the regions. They must be regions that Clumio supports.
-
To cover accounts that are added to the organization later, turn on Automatic deployment.
-
-
When the deployment finishes, return to Clumio and select Next. On Discover Linked Accounts, each account and region appears with its status. Discovery can take a few minutes for a large organization. You can select Done, and discovery continues in the background.
The accounts appear in the AWS > Connect table with the connection type CloudFormation (Via Organization).
Note
AWS doesn't include the management account in a StackSet deployment that uses service-managed permissions. To connect the management account, create a second StackSet from the same template with self-managed permissions, targeting only the management account.
For a large organization:
-
In the StackSet options, set Managed execution to Inactive so that operations run one at a time.
-
Each stack instance takes 2 to 3 minutes to deploy, and Clumio takes up to a few minutes more to set up each account and region. Start with a few critical accounts, and then raise the concurrency.
-
Check the AWS CloudFormation quotas for concurrent operations and stack instances. For information about the quotas, see Understand CloudFormation quotas.
To get the token and external ID without the portal, call PUT /connections/aws/org-deployment-parameters with your organization ID (aws_org_id). The response's token and external_id are the ClumioToken and RoleExternalId values. To get the template, call the Generate Connection Template API with asset_types_enabled set to the asset types to protect. For information about the API, see Generate Connection Template API.
For the optional template parameters, such as a permissions boundary, see CloudFormation template parameters.
Connect with Terraform
The Clumio Terraform provider registers the connection in Clumio, and the Clumio AWS module creates the roles, policies, and event rules in your account. You need the following:
-
A Clumio API token. To create one, go to Administration > Access management > API tokens.
-
The API base URL for your Clumio portal.
-
AWS credentials for the account that you're connecting.
For information about the API base URLs, see Clumio Provider.
-
In Clumio, go to AWS > Connect and select Add accounts > Add accounts with Terraform. The Clumio provider page opens in the Terraform Registry.
-
Follow its getting started guide. In your configuration, a
clumio_aws_connectionresource registers the account and region, and theclumio-code/aws-template/clumiomodule deploys to it. Turn on the asset types that you want with the module'sis_<type>_enabledinputs. -
Run
terraform init,terraform plan, andterraform apply.
The account appears in the AWS > Connect table with the connection type Terraform. Each clumio_aws_connection resource covers one region. Running terraform destroy removes both the AWS resources and the Clumio connection.
Connect manually
You create every AWS resource that Clumio needs yourself, from a permissions file that Clumio generates for the asset types that you select. Each manual connection covers one region.
-
In Clumio, go to AWS > Connect and select Add accounts > Add an account manually.
-
On Enter account info, enter the account ID, the region, and the asset types. Select Next.
-
On Deploy in AWS, copy the External User ID and select Download permissions to get
permissions.json. The file lists everything to create, grouped astopics,rules, androles. -
In the AWS console, in the region that you're connecting, create the resources in the file:
-
The SNS topic
ClumioEventPub, with the access policy from the file. -
Each EventBridge rule in the file, with its event pattern, targeting the topic.
-
Each IAM role in the file, with its trust policy, its customer managed policies, and its inline policies. Create the customer managed policies first, and then attach them.
The policies in the file contain placeholders. Replace each placeholder before you paste the policy:
Placeholder Replace with <<ROLEEXTERNALID>>The External User ID from step 3 <<CLUMIOEVENTPUB>>The ARN of the SNS topic <<NAME.ARN>>, for example<<CLUMIOIAMROLE.ARN>>The ARN of that rule or role <<NAME>>, for example<<CLUMIOS3BACKUPPOLICY>>The ARN of that managed policy Some policies refer to roles that you haven't created yet. A role's ARN is
arn:aws:iam::<account-id>:role/<role-name>, so you can fill it in before the role exists. -
-
Back on Deploy in AWS, paste each ARN into its field, and select Next. You can leave the fields marked (Optional) empty.
-
On Validate connection, Clumio checks its permissions and shows Has access for inventory, backup, and restore for each asset type. If an operation shows no access, fix that resource in AWS and select Refresh. Then select Done.
The account appears in the AWS > Connect table with the connection type Manual.
For what each role and policy in the file grants, see Clumio IAM roles and policies. For information about doing the same with the Terraform provider, see Manual onboarding process using Clumio Terraform provider.
After you connect
Edit a connection
Go to AWS > Connect, expand the account, and in the Actions column for the region, select Edit. What opens depends on how you connected:
-
CloudFormation: Opens Edit AWS account with CloudFormation, where you can add asset types (not remove them) and see the stack version. Select Update CloudFormation template to apply. For an account connected through AWS Organizations, the portal warns that a later StackSet update can override this change, so update the StackSet instead.
-
Terraform: Opens Update Terraform template. Change the connection in your Terraform configuration.
-
Manual: Opens View permissions, which shows what Clumio can do in the account. Select Refresh to check again after you change permissions in AWS, or Edit ARNs to point Clumio at different resources.
Update the Clumio stack
When a new version of the Clumio stack is available, the Clumio stack column in the AWS > Connect table shows Update available for the account. Expand the account to see Update to latest on each region that needs it.
For a connection made through AWS Organizations, you can update one account from the portal, or update the whole StackSet in AWS with the new template. Test an update on a few accounts first, to catch conflicts with service control policies or other IAM restrictions.
Update a CloudFormation connection
-
Sign in to the AWS account.
-
In the AWS > Connect table, expand the account and select Update to latest, and then Launch Update Stack Wizard.
-
Keep the default values and complete the Update stack wizard in AWS.
-
When the stack status is UPDATE_COMPLETE, return to Clumio and check that the update shows as complete.
Update a Terraform connection
Select Update to latest to see the new version, what changed, and a Copy environment token link. Then, from the folder that holds your Clumio Terraform configuration, run:
terraform init -upgrade
terraform plan
terraform apply
When a CloudFormation release is ahead of the Clumio AWS module, Clumio shows Update available even though you're on the latest module, sometimes straight after connecting. In that case, no action is needed.
Protect your assets
-
If this is the first data source that you've connected, configure the security settings for your Clumio account and invite users.
-
Create backup policies for the asset types that you want to protect, and apply them with AWS protection rules, or with protection groups for S3 buckets.