Skip to main content

The cloudparing CDK library

Project description

Cloudparing AWS CDK Construct Library

CDK constructs focused on monitoring and reducing cloud infrastructure costs.

Installation

TypeScript

https://www.npmjs.com/package/@cloudparing/aws-cdk-lib

In your package.json:

{
  "dependencies": {
    "@cloudparing/aws-cdk-lib": "^0.0.0",

    // peer dependencies
    "aws-cdk-lib": "^2.65.0",
    "constructs": "^10.0.5"

    // ...your other dependencies...
  }
}

Features

Cost and Usage Report (CUR) v2 Report

    const curBucket =
      props.bucket ||
      new cdk.aws_s3.Bucket(this, `Cur2Bucket`, {
        bucketName: `cur2-${cdk.Aws.ACCOUNT_ID}-${cdk.Aws.REGION}`,
      });

    new Cur2ExportDefinition(this, `Cur2ExportDefinition`, {
      name: 'cur2-daily-csv',
      description: props.exportDescription,
      bucket: curBucket,
    });

Legacy Cost and Usage Report (CUR)

An L2 construct and CDK stack for configuring the AWS Cost and Usage Report.

NOTE: The CUR report must be deployed to us-east-1

Example using the ReportDefinition construct:

    new ReportDefinition(this, `ReportDefinitionId`, {
      reportName: "CUR Report",
      s3Bucket: yourS3Bucket,
    });

Example using the provided Stacks:

import { CurStack, Cur2Stack } from '@cloudparing/aws-cdk-lib';
import * as cdk from 'aws-cdk-lib';

// for development, use account/region from cdk cli
const devEnv = {
  account: process.env.CDK_DEFAULT_ACCOUNT,
  region: process.env.CDK_DEFAULT_REGION,
};

const app = new cdk.App();

new CurStack(app, 'curStack-dev', {
  env: devEnv,
  stackName: 'CurStack',
  reportName: 'cur-daily-csv',
});

new Cur2Stack(app, 'cur2Stack-dev', {
  env: devEnv,
  stackName: 'Cur2Stack',
  name: 'cur2-daily-csv',
});

app.synth();

Both the L2 construct and the stack provide sensible defaults which can be customized by setting props.

    new ReportDefinition(this, `ReportDefinitionId`, {
      reportName: "CUR Report",
      s3Bucket: yourS3Bucket,
      format: 'Parquet'
    });

License

This project is licensed under the Apache-2.0 License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudparing.aws-cdk-0.0.19.tar.gz (16.6 MB view details)

Uploaded Source

Built Distribution

cloudparing.aws_cdk-0.0.19-py3-none-any.whl (16.6 MB view details)

Uploaded Python 3

File details

Details for the file cloudparing.aws-cdk-0.0.19.tar.gz.

File metadata

  • Download URL: cloudparing.aws-cdk-0.0.19.tar.gz
  • Upload date:
  • Size: 16.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cloudparing.aws-cdk-0.0.19.tar.gz
Algorithm Hash digest
SHA256 30da770ba410b5d5c511f74b0fdaf53218a46372b644636ef8545ad69f51679c
MD5 a41a7b7817619b79ef5816f626c8b100
BLAKE2b-256 edba7c10db5a45aac73f80e43c417865804443a2b097e70dda70aa0719cc660a

See more details on using hashes here.

File details

Details for the file cloudparing.aws_cdk-0.0.19-py3-none-any.whl.

File metadata

File hashes

Hashes for cloudparing.aws_cdk-0.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 8aaf0682a33b1330353081d5a933da89b72b90c307069ba2c0e9ea8ccc1855fb
MD5 184db951a31b32dfc2f861b9a70bc4d5
BLAKE2b-256 417d5f43cc0166f732d63dbd4e7c8654da922c1371cab17e7251096f0a4520c1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page