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.17.tar.gz (16.6 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cloudparing.aws-cdk-0.0.17.tar.gz
Algorithm Hash digest
SHA256 a32f0cad46cb8d9e6ec42a0a28f37053718d95f9306a78c696029e495b4132c4
MD5 2a9edf0004e040970946700744382ff7
BLAKE2b-256 597fba0fbb408a99f3dfc104cf9e63ceb7b2a081331355a6aaf65194ceeda656

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cloudparing.aws_cdk-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 1bcdc500599475158304f1c9eb72cfa9b45d8de8ef448d47d783778df726c004
MD5 4b43515dd9b83dc263f10fe19458d53d
BLAKE2b-256 c8b01cd294e94f011b4b825bce8f8a48d448843ed335f9d75c125feca57fdb8e

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