Getting Started with AnyCost Bucket
An AnyCost Bucket Adaptor automates the flow of cost data into CloudZero by allowing you to upload data from any cost source to an Amazon S3 bucket.
To set up an AnyCost Bucket connection, complete the following steps:
- Create an S3 bucket to store cost data.
- Register the connection in the CloudZero UI.
- Write the code that powers the Adaptor.
- Upload your cost data to S3.
All of CloudZero's AWS Permissions are Read-Only
AnyCost Bucket Adaptors write their cost data to an S3 bucket, and CloudZero requires the following permissions to read from that specific bucket:
s3:Get*
s3:List*
Note: If your AnyCost Bucket Adaptor writes to an S3 bucket in any region where STS is not active by default (such as
ap-east-1
oreu-south-1
), make sure you activate those regions following the Managing AWS STS in an AWS Region guide.
Prerequisites
- Ensure you have the Organizer role so you can create a new connection in CloudZero.
- Ensure you have an existing AWS Connection for the AWS account where your AnyCost Bucket Adaptor will store billing data.
Step 1: Create an S3 bucket to store data
First, create an Amazon S3 bucket in your AWS account. Your AnyCost Bucket Adaptor will write Common Bill Format .csv.gz
files to this bucket. To learn how to create a bucket, see the AWS documentation.
You will need the bucket name for the Bucket Name field in Step 2.
Inside the bucket, create a folder for the cost data and give it a meaningful name. For example, if the cost source is Sumo Logic, you could name the folder sumo-logic-cost-data
. The folder can be nested inside other folders, if needed (for example, cloudzero/sumo-logic-cost-data
).
You will need the folder path for the Bucket Path field in Step 2.
Note that creating a folder is required. AnyCost data cannot be stored at the root of the bucket (path /
).
Step 2: Register the Connection in the UI
Next, you must register your AnyCost Adaptor as a Billing Connection in the CloudZero UI.
In CloudZero, navigate to Settings by selecting the gear icon in the top navigation bar.
Select the Add Connection button.
Next, select the Custom tile and select Get started.
In Add a New Custom Connection page, fill out the following fields:
-
Connection Metadata
-
Cost Source: The description that will appear in the Cloud Provider Dimension and throughout the UI alongside AWS, Snowflake, Azure, GCP, and so on. For example, if you wrote an Adaptor for a service called Simple Cloud, you would enter
Simple Cloud
in this field. -
Connection Name: The name of this particular connection to the Cloud Provider. The connection name is typically used to distinguish between accounts, environments, and/or instances of the AnyCost adaptors. It cannot contain spaces, periods, or special characters (except for hyphens and underscores).
For example, if you are sending cost data from the Simple Cloud service for both your production and dev environments, the connection name might be
simple-cloud-prod
. -
Expected Data Delivery Frequency: Optional: How often your AnyCost Adaptor is expected to deliver data to the S3 bucket, in hours. Enter a whole number only. Providing this information helps CloudZero determine the health of your connection.
-
-
S3 Bucket Information
- AWS Connection: The existing AWS Connection with the S3 bucket that the AnyCost Adaptor will write Common Bill Format files into.
- Bucket Name: The name of the bucket you created in Step 1.
- Bucket Path: The path to the folder you created in Step 1. Do not include leading or trailing slashes in the path. For example, use
my/file/path
instead of/my/file/path/
. - Generate IAM Policy: Select this button to generate an IAM policy definition using the name of your S3 bucket. You must attach this policy to the CloudZero resource owner IAM role (named similar to
cloudzero-connected-account-live-ResourceOwner-Role-<RANDOM ID>
) to grant access to the billing data in your bucket. To learn how to attach a policy, see the AWS documentation.
Select Save.
Once created, your AnyCost Bucket connection appears in the Billing Connections table of the Cloud Integrations page.
Step 3: Write Code to Create a Custom Adaptor
After you create the connection in the CloudZero UI, you must write the code to create the AnyCost Adaptor. For instructions, see Creating AnyCost Custom Adaptors.
Step 4: Upload Cost Data to S3
Finally, upload cost data files to the S3 bucket. For details, see Configuring AnyCost Bucket File Drops.
CloudZero then connects to the S3 bucket, retrieves the cost data, validates it, and processes it.
When CloudZero has processed the first ingest of data, the Status changes from Pending Data to Healthy. This can take several hours.
If CloudZero can no longer connect to the bucket or if your AnyCost Bucket Adaptor is not writing data correctly, the Status is updated with details about the error.
Note that it can take up to a day to synchronize new accounts before you see cost data in the Explorer.
Updated 27 days ago