https://github.com/iamfrench/terraform-aws-billing-export
Terraform Module witch creates billing export, including FOCUS, on AWS.
https://github.com/iamfrench/terraform-aws-billing-export
aws aws-billing aws-cur finops finops-focus focus terraform terraform-modules
Last synced: about 1 month ago
JSON representation
Terraform Module witch creates billing export, including FOCUS, on AWS.
- Host: GitHub
- URL: https://github.com/iamfrench/terraform-aws-billing-export
- Owner: IAmFrench
- License: apache-2.0
- Created: 2023-03-23T22:07:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T17:49:21.000Z (7 months ago)
- Last Synced: 2025-04-12T21:20:58.718Z (2 months ago)
- Topics: aws, aws-billing, aws-cur, finops, finops-focus, focus, terraform, terraform-modules
- Language: HCL
- Homepage: https://registry.terraform.io/modules/IAmFrench/billing-export/aws/latest
- Size: 18.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Amazon Web Services (AWS) Billing export Terraform Module
Terraform module witch creates billing export on AWS.
FOCUS v1.0 billing export for AWS now available!
This module will create S3 bucket for AWS billing exports.
## What is FOCUS™?
The FinOps Cost and Usage Specification (FOCUS™) is an open-source specification that defines clear requirements for cloud vendors to produce consistent cost and usage datasets.
Supported by the FinOps Foundation, FOCUS™ aims to reduce complexity for FinOps Practitioners so they can drive data-driven decision-making and maximize the business value of cloud, while making their skills more transferable across clouds, tools, and organizations.
Learn more about FOCUS in this [FinOps Foundation Insights article](https://www.finops.org/insights/focus-1-0-available/).
## Usage
```terraform
# FOCUS v1.0 AWS billing export with the creation of the S3 bucket
module "aws_billing_export" {
source = "IAmFrench/billing-export/aws"
# Version of this module, see release on GitHub: https://github.com/IAmFrench/terraform-aws-billing-export/releases
version = "1.0.4"
# Name of the S3 bucket to create exports in
s3_bucket_name = "finops-exports-1a2b3c4d"
# Type of the export
export_type = "FOCUS"
# Version of the export
export_version = "1.0"
# Name of the export
export_name = "focus-v1-0-export"
# Prefix of the export
export_s3_prefix = "focus/v1.0/1234556789"
}
```
```terraform
# FOCUS v1.0 AWS billing export with an existing S3 bucket
module "aws_billing_export" {
source = "IAmFrench/billing-export/aws"
# Version of this module, see release on GitHub: https://github.com/IAmFrench/terraform-aws-billing-export/releases
version = "1.0.4"
# Name of the S3 bucket to create exports in
s3_bucket_name = data.aws_s3_bucket.export.id
# Should this module create the S3 bucket with associated policy?
create_s3_bucket = false
# Type of the export
export_type = "FOCUS"
# Version of the export
export_version = "1.0"
# Name of the export
export_name = "focus-v1-0-export"
# Prefix of the export
export_s3_prefix = "focus/v1.0/1234556789"
}
```
## Roadmap
- [X] FOCUS `v1.0` export [Data Exports for FOCUS 1.0 is now in general availability](https://aws.amazon.com/blogs/aws-cloud-financial-management/data-exports-for-focus-1-0-is-now-generally-available/)
- [X] FOCUS `v1.0-preview` export [Announcing Data Exports for FOCUS 1.0 (Preview) in AWS Billing and Cost Management](https://aws.amazon.com/blogs/aws-cloud-financial-management/announcing-data-exports-for-focus-1-0-preview-in-aws-billing-and-cost-management/)
- [ ] CUR `v2` export [Introducing Data Exports for AWS Billing and Cost Management](https://aws.amazon.com/blogs/aws-cloud-financial-management/introducing-data-exports-for-billing-and-cost-management/)
- [ ] CUR `legacy` export [Creating a Legacy CUR export](https://docs.aws.amazon.com/cur/latest/userguide/dataexports-create-legacy.html)
## Common errors
- `ValidationException: S3 bucket permission validation failed`: The existing S3 bucket is missing the policy to allow AWS export services to write to the bucket, see https://docs.aws.amazon.com/cur/latest/userguide/dataexports-s3-bucket.html
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.1.0 |
| [aws](#requirement\_aws) | >= 5.47.0 |
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | >= 5.47.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_bcmdataexports_export.focus](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/bcmdataexports_export) | resource |
| [aws_s3_bucket.export](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
| [aws_s3_bucket_policy.allow_data_export](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
| [aws_iam_policy_document.allow_data_export](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_s3_bucket.export](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket) | data source |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [create\_s3\_bucket](#input\_create\_s3\_bucket) | Option to create or not the S3 bucket for the billing export.
If set to `false`, this module will not create the S3 bucket.
Therefore please check that bucket policies are sets to allow AWS export services to write files in it.
More info: https://docs.aws.amazon.com/cur/latest/userguide/dataexports-s3-bucket.html
E.g.: `true`, `false` | `bool` | `true` | no |
| [export\_name](#input\_export\_name) | Name of the billing export.
Validation: Export name must be unique, not include spaces, and contain only alphanumeric and characters ! - \_ . * ' ( )
E.g.: `focus-v1-0-preview` | `string` | n/a | yes |
| [export\_s3\_prefix](#input\_export\_s3\_prefix) | Prefix of the billing export.
E.g.: `focus/123456789` with `123456789` being the account id | `string` | `""` | no |
| [export\_type](#input\_export\_type) | Version of the billing export.
Valid values: `FOCUS` or `CUR`
E.g.: `FOCUS` or `CUR` | `string` | n/a | yes |
| [export\_version](#input\_export\_version) | Version of the billing export. Should be use with `export_type`.
Valid values are:
- `1.0` and `1.0-preview` for FOCUS
- `legacy` or `2.0` for CUR
E.g.: `1.0`, `1.0-preview`, `legacy`, `2.0` | `string` | n/a | yes |
| [s3\_bucket\_name](#input\_s3\_bucket\_name) | Name of the S3 bucket to be created
E.g.: `finops-focus-export-a1b2c3d4` | `string` | n/a | yes |
| [tags](#input\_tags) | Tags to apply to all created resources.
E.g.:
{
createdBy = "Terraform"
} | `map(string)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| [export\_arn](#output\_export\_arn) | ARN of the export |
| [s3\_arn](#output\_s3\_arn) | ARN of the export bucket |