Skip to content
This repository has been archived by the owner on Dec 30, 2023. It is now read-only.

Latest commit

 

History

History
2440 lines (1482 loc) · 87.6 KB

API.md

File metadata and controls

2440 lines (1482 loc) · 87.6 KB
Raw

API Reference

Constructs

BillTheBot

L3 construct to create a new Bill Bot.

Initializers 

import { BillTheBot } from '@cremich/cdk-bill-bot'

new BillTheBot(scope: Construct, id: string, props: BillProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props BillProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BillTheBot } from '@cremich/cdk-bill-bot'

BillTheBot.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
dailySpendsDigest DailySpendsDigest No description.
datacatalog CostAndUsageDataCatalog No description.
report CostAndUsageReport No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

dailySpendsDigestRequired 
public readonly dailySpendsDigest: DailySpendsDigest;
datacatalogRequired 
public readonly datacatalog: CostAndUsageDataCatalog;
reportRequired 
public readonly report: CostAndUsageReport;

CostAndUsageDataCatalog

A new cost and usage data catalog containing - an AWS Glue crawler - an Amazon Athena workgroup to query data - an S3 Bucket where Amazon Athena can write the results into.

Initializers 

import { CostAndUsageDataCatalog } from '@cremich/cdk-bill-bot'

new CostAndUsageDataCatalog(scope: Construct, id: string, props: CostAndUsageDataCatalogProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CostAndUsageDataCatalogProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { CostAndUsageDataCatalog } from '@cremich/cdk-bill-bot'

CostAndUsageDataCatalog.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
athenaBucket aws-cdk-lib.aws_s3.IBucket The bucket where Amazon Athena writes query results.
athenaWorkgroup aws-cdk-lib.aws_athena.CfnWorkGroup The name of the Amazon Athena workgroup to query the data catalog.
crawler aws-cdk-lib.aws_glue.CfnCrawler The name of the AWS Glue crawler that creates the data catalog.
curBucket aws-cdk-lib.aws_s3.IBucket The bucket where AWS delivers the report.
glueDatabase aws-cdk-lib.aws_glue.CfnDatabase The name of the AWS Glue database for your cost and usage data.
glueTableName string The name of the AWS Glue table to query your cost and usage data.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

athenaBucketRequired 
public readonly athenaBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket

The bucket where Amazon Athena writes query results.

athenaWorkgroupRequired 
public readonly athenaWorkgroup: CfnWorkGroup;
  • Type: aws-cdk-lib.aws_athena.CfnWorkGroup

The name of the Amazon Athena workgroup to query the data catalog.

crawlerRequired 
public readonly crawler: CfnCrawler;
  • Type: aws-cdk-lib.aws_glue.CfnCrawler

The name of the AWS Glue crawler that creates the data catalog.

curBucketRequired 
public readonly curBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket

The bucket where AWS delivers the report.

glueDatabaseRequired 
public readonly glueDatabase: CfnDatabase;
  • Type: aws-cdk-lib.aws_glue.CfnDatabase

The name of the AWS Glue database for your cost and usage data.

glueTableNameRequired 
public readonly glueTableName: string;
  • Type: string

The name of the AWS Glue table to query your cost and usage data.

CostAndUsageReport

A new AWS cost and usage report.

Initializers 

import { CostAndUsageReport } from '@cremich/cdk-bill-bot'

new CostAndUsageReport(scope: Construct, id: string, props: CostAndUsageReportProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CostAndUsageReportProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
addDataCatalog Creates a new data catalog within AWS Glue to crawl and analyze data for this report.
toString 
public toString(): string

Returns a string representation of this construct.

addDataCatalog 
public addDataCatalog(): CostAndUsageDataCatalog

Creates a new data catalog within AWS Glue to crawl and analyze data for this report.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { CostAndUsageReport } from '@cremich/cdk-bill-bot'

CostAndUsageReport.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
bucket CURBucket The bucket where AWS delivers the report.
name string The name of the cost and usage report.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

bucketRequired 
public readonly bucket: CURBucket;

The bucket where AWS delivers the report.

nameRequired 
public readonly name: string;
  • Type: string

The name of the cost and usage report.

CURBucket

A new Amazon S3 bucket for cost and usage reports.

Initializers 

import { CURBucket } from '@cremich/cdk-bill-bot'

new CURBucket(scope: Construct, id: string, props?: CURBucketProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CURBucketProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional

Methods

Name Description
toString Returns a string representation of this construct.
applyRemovalPolicy Apply the given removal policy to this resource.
addEventNotification Adds a bucket notification event destination.
addObjectCreatedNotification Subscribes a destination to receive notifications when an object is created in the bucket.
addObjectRemovedNotification Subscribes a destination to receive notifications when an object is removed from the bucket.
addToResourcePolicy Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use bucketArn and arnForObjects(keys) to obtain ARNs for this bucket or objects.
arnForObjects Returns an ARN that represents all objects within the bucket that match the key pattern specified.
grantDelete Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
grantPublicAccess Allows unrestricted access to objects from this bucket.
grantPut Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
grantPutAcl Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.
grantRead Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
grantReadWrite Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
grantWrite Grant write permissions to this bucket to an IAM principal.
onCloudTrailEvent Define a CloudWatch event that triggers when something happens to this repository.
onCloudTrailPutObject Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.
onCloudTrailWriteObject Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
s3UrlForObject The S3 URL of an S3 object. For example:.
transferAccelerationUrlForObject The https Transfer Acceleration URL of an S3 object.
urlForObject The https URL of an S3 object. Specify regional: false at the options for non-regional URLs. For example:.
virtualHostedUrlForObject The virtual hosted-style URL of an S3 object. Specify regional: false at the options for non-regional URL. For example:.
addCorsRule Adds a cross-origin access configuration for objects in an Amazon S3 bucket.
addInventory Add an inventory configuration.
addLifecycleRule Add a lifecycle rule to the bucket.
addMetric Adds a metrics configuration for the CloudWatch request metrics from the bucket.
toString 
public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy 
public applyRemovalPolicy(policy: RemovalPolicy): void

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

policyRequired
  • Type: aws-cdk-lib.RemovalPolicy
addEventNotification 
public addEventNotification(event: EventType, dest: IBucketNotificationDestination, filters: NotificationKeyFilter): void

Adds a bucket notification event destination.

https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html

Example

   declare const myLambda: lambda.Function;
   const bucket = new s3.Bucket(this, 'MyBucket');
   bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(myLambda), {prefix: 'home/myusername/*'});
eventRequired
  • Type: aws-cdk-lib.aws_s3.EventType

The event to trigger the notification.

destRequired
  • Type: aws-cdk-lib.aws_s3.IBucketNotificationDestination

The notification destination (Lambda, SNS Topic or SQS Queue).

filtersRequired
  • Type: aws-cdk-lib.aws_s3.NotificationKeyFilter

S3 object key filter rules to determine which objects trigger this event.

Each filter must include a prefix and/or suffix that will be matched against the s3 object key. Refer to the S3 Developer Guide for details about allowed filter rules.

addObjectCreatedNotification 
public addObjectCreatedNotification(dest: IBucketNotificationDestination, filters: NotificationKeyFilter): void

Subscribes a destination to receive notifications when an object is created in the bucket.

This is identical to calling onEvent(EventType.OBJECT_CREATED).

destRequired
  • Type: aws-cdk-lib.aws_s3.IBucketNotificationDestination

The notification destination (see onEvent).

filtersRequired
  • Type: aws-cdk-lib.aws_s3.NotificationKeyFilter

Filters (see onEvent).

addObjectRemovedNotification 
public addObjectRemovedNotification(dest: IBucketNotificationDestination, filters: NotificationKeyFilter): void

Subscribes a destination to receive notifications when an object is removed from the bucket.

This is identical to calling onEvent(EventType.OBJECT_REMOVED).

destRequired
  • Type: aws-cdk-lib.aws_s3.IBucketNotificationDestination

The notification destination (see onEvent).

filtersRequired
  • Type: aws-cdk-lib.aws_s3.NotificationKeyFilter

Filters (see onEvent).

addToResourcePolicy 
public addToResourcePolicy(permission: PolicyStatement): AddToResourcePolicyResult

Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use bucketArn and arnForObjects(keys) to obtain ARNs for this bucket or objects.

Note that the policy statement may or may not be added to the policy. For example, when an IBucket is created from an existing bucket, it's not possible to tell whether the bucket already has a policy attached, let alone to re-use that policy to add more statements to it. So it's safest to do nothing in these cases.

permissionRequired
  • Type: aws-cdk-lib.aws_iam.PolicyStatement

the policy statement to be added to the bucket's policy.

arnForObjects 
public arnForObjects(keyPattern: string): string

Returns an ARN that represents all objects within the bucket that match the key pattern specified.

To represent all keys, specify "*".

If you need to specify a keyPattern with multiple components, concatenate them into a single string, e.g.:

arnForObjects(home/${team}/${user}/*)

keyPatternRequired
  • Type: string
grantDelete 
public grantDelete(identity: IGrantable, objectsKeyPattern?: any): Grant

Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable

The principal.

objectsKeyPatternOptional
  • Type: any

Restrict the permission to a certain key pattern (default '*').

grantPublicAccess 
public grantPublicAccess(allowedActions: string, keyPrefix?: string): Grant

Allows unrestricted access to objects from this bucket.

IMPORTANT: This permission allows anyone to perform actions on S3 objects in this bucket, which is useful for when you configure your bucket as a website and want everyone to be able to read objects in the bucket without needing to authenticate.

Without arguments, this method will grant read ("s3:GetObject") access to all objects ("*") in the bucket.

The method returns the iam.Grant object, which can then be modified as needed. For example, you can add a condition that will restrict access only to an IPv4 range like this:

 const grant = bucket.grantPublicAccess();
 grant.resourceStatement!.addCondition(‘IpAddress’, { “aws:SourceIp”: “54.240.143.0/24” });

Note that if this IBucket refers to an existing bucket, possibly not managed by CloudFormation, this method will have no effect, since it's impossible to modify the policy of an existing bucket.

allowedActionsRequired
  • Type: string

the set of S3 actions to allow.

Default is "s3:GetObject".

keyPrefixOptional
  • Type: string

the prefix of S3 object keys (e.g. home/*). Default is "*".

grantPut 
public grantPut(identity: IGrantable, objectsKeyPattern?: any): Grant

Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.

If encryption is used, permission to use the key to encrypt the contents of written files will also be granted to the same principal.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable

The principal.

objectsKeyPatternOptional
  • Type: any

Restrict the permission to a certain key pattern (default '*').

grantPutAcl 
public grantPutAcl(identity: IGrantable, objectsKeyPattern?: string): Grant

Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.

If your application has the '@aws-cdk/aws-s3:grantWriteWithoutAcl' feature flag set, calling {@link grantWrite} or {@link grantReadWrite} no longer grants permissions to modify the ACLs of the objects; in this case, if you need to modify object ACLs, call this method explicitly.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
objectsKeyPatternOptional
  • Type: string
grantRead 
public grantRead(identity: IGrantable, objectsKeyPattern?: any): Grant

Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).

If encryption is used, permission to use the key to decrypt the contents of the bucket will also be granted to the same principal.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable

The principal.

objectsKeyPatternOptional
  • Type: any

Restrict the permission to a certain key pattern (default '*').

grantReadWrite 
public grantReadWrite(identity: IGrantable, objectsKeyPattern?: any): Grant

Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).

If an encryption key is used, permission to use the key for encrypt/decrypt will also be granted.

Before CDK version 1.85.0, this method granted the s3:PutObject* permission that included s3:PutObjectAcl, which could be used to grant read/write object access to IAM principals in other accounts. If you want to get rid of that behavior, update your CDK version to 1.85.0 or later, and make sure the @aws-cdk/aws-s3:grantWriteWithoutAcl feature flag is set to true in the context key of your cdk.json file. If you've already updated, but still need the principal to have permissions to modify the ACLs, use the {@link grantPutAcl} method.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
objectsKeyPatternOptional
  • Type: any
grantWrite 
public grantWrite(identity: IGrantable, objectsKeyPattern?: any): Grant

Grant write permissions to this bucket to an IAM principal.

If encryption is used, permission to use the key to encrypt the contents of written files will also be granted to the same principal.

Before CDK version 1.85.0, this method granted the s3:PutObject* permission that included s3:PutObjectAcl, which could be used to grant read/write object access to IAM principals in other accounts. If you want to get rid of that behavior, update your CDK version to 1.85.0 or later, and make sure the @aws-cdk/aws-s3:grantWriteWithoutAcl feature flag is set to true in the context key of your cdk.json file. If you've already updated, but still need the principal to have permissions to modify the ACLs, use the {@link grantPutAcl} method.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
objectsKeyPatternOptional
  • Type: any
onCloudTrailEvent 
public onCloudTrailEvent(id: string, options?: OnCloudTrailBucketEventOptions): Rule

Define a CloudWatch event that triggers when something happens to this repository.

Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.

idRequired
  • Type: string

The id of the rule.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions

Options for adding the rule.

onCloudTrailPutObject 
public onCloudTrailPutObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule

Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.

Note that some tools like aws s3 cp will automatically use either PutObject or the multipart upload API depending on the file size, so using onCloudTrailWriteObject may be preferable.

Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.

idRequired
  • Type: string

The id of the rule.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions

Options for adding the rule.

onCloudTrailWriteObject 
public onCloudTrailWriteObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule

Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.

This includes the events PutObject, CopyObject, and CompleteMultipartUpload.

Note that some tools like aws s3 cp will automatically use either PutObject or the multipart upload API depending on the file size, so using this method may be preferable to onCloudTrailPutObject.

Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.

idRequired
  • Type: string

The id of the rule.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions

Options for adding the rule.

s3UrlForObject 
public s3UrlForObject(key?: string): string

The S3 URL of an S3 object. For example:.

s3://onlybucket

  • s3://bucket/key
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the S3 URL of the bucket is returned.

transferAccelerationUrlForObject 
public transferAccelerationUrlForObject(key?: string, options?: TransferAccelerationUrlOptions): string

The https Transfer Acceleration URL of an S3 object.

Specify dualStack: true at the options for dual-stack endpoint (connect to the bucket over IPv6). For example:

  • https://bucket.s3-accelerate.amazonaws.com
  • https://bucket.s3-accelerate.amazonaws.com/key
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the URL of the bucket is returned.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.TransferAccelerationUrlOptions

Options for generating URL.

urlForObject 
public urlForObject(key?: string): string

The https URL of an S3 object. Specify regional: false at the options for non-regional URLs. For example:.

https://s3.us-west-1.amazonaws.com/onlybucket

  • https://s3.us-west-1.amazonaws.com/bucket/key
  • https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the URL of the bucket is returned.

virtualHostedUrlForObject 
public virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string

The virtual hosted-style URL of an S3 object. Specify regional: false at the options for non-regional URL. For example:.

https://only-bucket.s3.us-west-1.amazonaws.com

  • https://bucket.s3.us-west-1.amazonaws.com/key
  • https://bucket.s3.amazonaws.com/key
  • https://china-bucket.s3.cn-north-1.amazonaws.com.cn/mykey
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the URL of the bucket is returned.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.VirtualHostedStyleUrlOptions

Options for generating URL.

addCorsRule 
public addCorsRule(rule: CorsRule): void

Adds a cross-origin access configuration for objects in an Amazon S3 bucket.

ruleRequired
  • Type: aws-cdk-lib.aws_s3.CorsRule

The CORS configuration rule to add.

addInventory 
public addInventory(inventory: Inventory): void

Add an inventory configuration.

inventoryRequired
  • Type: aws-cdk-lib.aws_s3.Inventory

configuration to add.

addLifecycleRule 
public addLifecycleRule(rule: LifecycleRule): void

Add a lifecycle rule to the bucket.

ruleRequired
  • Type: aws-cdk-lib.aws_s3.LifecycleRule

The rule to add.

addMetric 
public addMetric(metric: BucketMetrics): void

Adds a metrics configuration for the CloudWatch request metrics from the bucket.

metricRequired
  • Type: aws-cdk-lib.aws_s3.BucketMetrics

The metric configuration to add.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isResource Check whether the given construct is a Resource.
fromBucketArn No description.
fromBucketAttributes Creates a Bucket construct that represents an external bucket.
fromBucketName No description.
validateBucketName Thrown an exception if the given bucket name is not valid.
isConstruct 
import { CURBucket } from '@cremich/cdk-bill-bot'

CURBucket.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isResource 
import { CURBucket } from '@cremich/cdk-bill-bot'

CURBucket.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

constructRequired
  • Type: constructs.IConstruct
fromBucketArn 
import { CURBucket } from '@cremich/cdk-bill-bot'

CURBucket.fromBucketArn(scope: Construct, id: string, bucketArn: string)
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
bucketArnRequired
  • Type: string
fromBucketAttributes 
import { CURBucket } from '@cremich/cdk-bill-bot'

CURBucket.fromBucketAttributes(scope: Construct, id: string, attrs: BucketAttributes)

Creates a Bucket construct that represents an external bucket.

scopeRequired
  • Type: constructs.Construct

The parent creating construct (usually this).

idRequired
  • Type: string

The construct's name.

attrsRequired
  • Type: aws-cdk-lib.aws_s3.BucketAttributes

A BucketAttributes object.

Can be obtained from a call to bucket.export() or manually created.

fromBucketName 
import { CURBucket } from '@cremich/cdk-bill-bot'

CURBucket.fromBucketName(scope: Construct, id: string, bucketName: string)
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
bucketNameRequired
  • Type: string
validateBucketName 
import { CURBucket } from '@cremich/cdk-bill-bot'

CURBucket.validateBucketName(physicalName: string)

Thrown an exception if the given bucket name is not valid.

physicalNameRequired
  • Type: string

name of the bucket.

Properties

Name Type Description
node constructs.Node The tree node.
env aws-cdk-lib.ResourceEnvironment The environment this resource belongs to.
stack aws-cdk-lib.Stack The stack in which this resource is defined.
bucketArn string The ARN of the bucket.
bucketDomainName string The IPv4 DNS name of the specified bucket.
bucketDualStackDomainName string The IPv6 DNS name of the specified bucket.
bucketName string The name of the bucket.
bucketRegionalDomainName string The regional domain name of the specified bucket.
bucketWebsiteDomainName string The Domain name of the static website.
bucketWebsiteUrl string The URL of the static website.
encryptionKey aws-cdk-lib.aws_kms.IKey Optional KMS encryption key associated with this bucket.
isWebsite boolean If this bucket has been configured for static website hosting.
policy aws-cdk-lib.aws_s3.BucketPolicy The resource policy associated with this bucket.
region string The region this bucket is provisioned.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

envRequired 
public readonly env: ResourceEnvironment;
  • Type: aws-cdk-lib.ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stackRequired 
public readonly stack: Stack;
  • Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

bucketArnRequired 
public readonly bucketArn: string;
  • Type: string

The ARN of the bucket.

bucketDomainNameRequired 
public readonly bucketDomainName: string;
  • Type: string

The IPv4 DNS name of the specified bucket.

bucketDualStackDomainNameRequired 
public readonly bucketDualStackDomainName: string;
  • Type: string

The IPv6 DNS name of the specified bucket.

bucketNameRequired 
public readonly bucketName: string;
  • Type: string

The name of the bucket.

bucketRegionalDomainNameRequired 
public readonly bucketRegionalDomainName: string;
  • Type: string

The regional domain name of the specified bucket.

bucketWebsiteDomainNameRequired 
public readonly bucketWebsiteDomainName: string;
  • Type: string

The Domain name of the static website.

bucketWebsiteUrlRequired 
public readonly bucketWebsiteUrl: string;
  • Type: string

The URL of the static website.

encryptionKeyOptional 
public readonly encryptionKey: IKey;
  • Type: aws-cdk-lib.aws_kms.IKey

Optional KMS encryption key associated with this bucket.

isWebsiteOptional 
public readonly isWebsite: boolean;
  • Type: boolean

If this bucket has been configured for static website hosting.

policyOptional 
public readonly policy: BucketPolicy;
  • Type: aws-cdk-lib.aws_s3.BucketPolicy

The resource policy associated with this bucket.

If autoCreatePolicy is true, a BucketPolicy will be created upon the first call to addToResourcePolicy(s).

regionRequired 
public readonly region: string;
  • Type: string

The region this bucket is provisioned.

DailySpendsDigest

A new set of resources to provide a daily spends digest.

Initializers 

import { DailySpendsDigest } from '@cremich/cdk-bill-bot'

new DailySpendsDigest(scope: Construct, id: string, props: DailySpendsDigestProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props DailySpendsDigestProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { DailySpendsDigest } from '@cremich/cdk-bill-bot'

DailySpendsDigest.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
preparedStatement aws-cdk-lib.aws_athena.CfnPreparedStatement No description.
stateMachine aws-cdk-lib.aws_stepfunctions.StateMachine No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

preparedStatementRequired 
public readonly preparedStatement: CfnPreparedStatement;
  • Type: aws-cdk-lib.aws_athena.CfnPreparedStatement
stateMachineRequired 
public readonly stateMachine: StateMachine;
  • Type: aws-cdk-lib.aws_stepfunctions.StateMachine

Structs

BillProps

Properties for creating Bill - the serverless cost optimization bot.

Initializer 

import { BillProps } from '@cremich/cdk-bill-bot'

const billProps: BillProps = { ... }

Properties

Name Type Description
slackWebHookUrl string The URL of your Slack Webhook where Bill sends messages to.
slackWebHookUrlRequired 
public readonly slackWebHookUrl: string;
  • Type: string

The URL of your Slack Webhook where Bill sends messages to.

CostAndUsageDataCatalogProps

Properties for creating an AWS Cost and Usage data catalog.

Initializer 

import { CostAndUsageDataCatalogProps } from '@cremich/cdk-bill-bot'

const costAndUsageDataCatalogProps: CostAndUsageDataCatalogProps = { ... }

Properties

Name Type Description
curBucket aws-cdk-lib.aws_s3.IBucket The S3 bucket that contains the cost and usage report.
reportPathPrefix string The S3 report path prefix.
curBucketRequired 
public readonly curBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket

The S3 bucket that contains the cost and usage report.

reportPathPrefixOptional 
public readonly reportPathPrefix: string;
  • Type: string

The S3 report path prefix.

If not provided, we will fallback to a default of <account_id>_cur. This value will influence where to crawl the data to prevent creating too many tables as well as the final name of the Glue table that is created

https://docs.aws.amazon.com/cur/latest/userguide/cur-create.html

CostAndUsageReportProps

Properties for creating an AWS Cost and Usage Report.

Initializer 

import { CostAndUsageReportProps } from '@cremich/cdk-bill-bot'

const costAndUsageReportProps: CostAndUsageReportProps = { ... }

Properties

Name Type Description
compression Compression No description.
format Format No description.
timeUnit TimeUnit No description.
bucket CURBucket No description.
refreshClosedReports boolean No description.
versioning Versioning No description.
compressionRequired 
public readonly compression: Compression;
formatRequired 
public readonly format: Format;
timeUnitRequired 
public readonly timeUnit: TimeUnit;
bucketOptional 
public readonly bucket: CURBucket;
refreshClosedReportsOptional 
public readonly refreshClosedReports: boolean;
  • Type: boolean
versioningOptional 
public readonly versioning: Versioning;

CURBucketProps

Properties for creating an Amazon S3 bucket for cost and usage reports.

Initializer 

import { CURBucketProps } from '@cremich/cdk-bill-bot'

const cURBucketProps: CURBucketProps = { ... }

Properties

Name Type Description
accessControl aws-cdk-lib.aws_s3.BucketAccessControl Specifies a canned ACL that grants predefined permissions to the bucket.
autoDeleteObjects boolean Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
blockPublicAccess aws-cdk-lib.aws_s3.BlockPublicAccess The block public access configuration of this bucket.
bucketKeyEnabled boolean Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.
bucketName string Physical name of this bucket.
cors aws-cdk-lib.aws_s3.CorsRule[] The CORS configuration of this bucket.
encryption aws-cdk-lib.aws_s3.BucketEncryption The kind of server-side encryption to apply to this bucket.
encryptionKey aws-cdk-lib.aws_kms.IKey External KMS key to use for bucket encryption.
enforceSSL boolean Enforces SSL for requests.
inventories aws-cdk-lib.aws_s3.Inventory[] The inventory configuration of the bucket.
lifecycleRules aws-cdk-lib.aws_s3.LifecycleRule[] Rules that define how Amazon S3 manages objects during their lifetime.
metrics aws-cdk-lib.aws_s3.BucketMetrics[] The metrics configuration of this bucket.
objectOwnership aws-cdk-lib.aws_s3.ObjectOwnership The objectOwnership of the bucket.
publicReadAccess boolean Grants public read access to all objects in the bucket.
removalPolicy aws-cdk-lib.RemovalPolicy Policy to apply when the bucket is removed from this stack.
serverAccessLogsBucket aws-cdk-lib.aws_s3.IBucket Destination bucket for the server access logs.
serverAccessLogsPrefix string Optional log file prefix to use for the bucket's access logs.
transferAcceleration boolean Whether this bucket should have transfer acceleration turned on or not.
versioned boolean Whether this bucket should have versioning turned on or not.
websiteErrorDocument string The name of the error document (e.g. "404.html") for the website. websiteIndexDocument must also be set if this is set.
websiteIndexDocument string The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.
websiteRedirect aws-cdk-lib.aws_s3.RedirectTarget Specifies the redirect behavior of all requests to a website endpoint of a bucket.
websiteRoutingRules aws-cdk-lib.aws_s3.RoutingRule[] Rules that define when a redirect is applied and the redirect behavior.
accessControlOptional 
public readonly accessControl: BucketAccessControl;
  • Type: aws-cdk-lib.aws_s3.BucketAccessControl
  • Default: BucketAccessControl.PRIVATE

Specifies a canned ACL that grants predefined permissions to the bucket.

autoDeleteObjectsOptional 
public readonly autoDeleteObjects: boolean;
  • Type: boolean
  • Default: false

Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.

Requires the removalPolicy to be set to RemovalPolicy.DESTROY.

Warning if you have deployed a bucket with autoDeleteObjects: true, switching this to false in a CDK version before 1.126.0 will lead to all objects in the bucket being deleted. Be sure to update your bucket resources by deploying with CDK version 1.126.0 or later before switching this value to false.

blockPublicAccessOptional 
public readonly blockPublicAccess: BlockPublicAccess;
  • Type: aws-cdk-lib.aws_s3.BlockPublicAccess
  • Default: CloudFormation defaults will apply. New buckets and objects don't allow public access, but users can modify bucket policies or object permissions to allow public access

The block public access configuration of this bucket.

https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html

bucketKeyEnabledOptional 
public readonly bucketKeyEnabled: boolean;
  • Type: boolean
  • Default: false

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.

Only relevant, when Encryption is set to {@link BucketEncryption.KMS}

bucketNameOptional 
public readonly bucketName: string;
  • Type: string
  • Default: Assigned by CloudFormation (recommended).

Physical name of this bucket.

corsOptional 
public readonly cors: CorsRule[];
  • Type: aws-cdk-lib.aws_s3.CorsRule[]
  • Default: No CORS configuration.

The CORS configuration of this bucket.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html

encryptionOptional 
public readonly encryption: BucketEncryption;
  • Type: aws-cdk-lib.aws_s3.BucketEncryption
  • Default: Kms if encryptionKey is specified, or Unencrypted otherwise.

The kind of server-side encryption to apply to this bucket.

If you choose KMS, you can specify a KMS key via encryptionKey. If encryption key is not specified, a key will automatically be created.

encryptionKeyOptional 
public readonly encryptionKey: IKey;
  • Type: aws-cdk-lib.aws_kms.IKey
  • Default: If encryption is set to "Kms" and this property is undefined, a new KMS key will be created and associated with this bucket.

External KMS key to use for bucket encryption.

The 'encryption' property must be either not specified or set to "Kms". An error will be emitted if encryption is set to "Unencrypted" or "Managed".

enforceSSLOptional 
public readonly enforceSSL: boolean;
  • Type: boolean
  • Default: false

Enforces SSL for requests.

S3.5 of the AWS Foundational Security Best Practices Regarding S3.

https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html

inventoriesOptional 
public readonly inventories: Inventory[];
  • Type: aws-cdk-lib.aws_s3.Inventory[]
  • Default: No inventory configuration

The inventory configuration of the bucket.

https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html

lifecycleRulesOptional 
public readonly lifecycleRules: LifecycleRule[];
  • Type: aws-cdk-lib.aws_s3.LifecycleRule[]
  • Default: No lifecycle rules.

Rules that define how Amazon S3 manages objects during their lifetime.

metricsOptional 
public readonly metrics: BucketMetrics[];
  • Type: aws-cdk-lib.aws_s3.BucketMetrics[]
  • Default: No metrics configuration.

The metrics configuration of this bucket.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html

objectOwnershipOptional 
public readonly objectOwnership: ObjectOwnership;
  • Type: aws-cdk-lib.aws_s3.ObjectOwnership
  • Default: No ObjectOwnership configuration, uploading account will own the object.

The objectOwnership of the bucket.

https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html

publicReadAccessOptional 
public readonly publicReadAccess: boolean;
  • Type: boolean
  • Default: false

Grants public read access to all objects in the bucket.

Similar to calling bucket.grantPublicAccess()

removalPolicyOptional 
public readonly removalPolicy: RemovalPolicy;
  • Type: aws-cdk-lib.RemovalPolicy
  • Default: The bucket will be orphaned.

Policy to apply when the bucket is removed from this stack.

serverAccessLogsBucketOptional 
public readonly serverAccessLogsBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
  • Default: If "serverAccessLogsPrefix" undefined - access logs disabled, otherwise - log to current bucket.

Destination bucket for the server access logs.

serverAccessLogsPrefixOptional 
public readonly serverAccessLogsPrefix: string;
  • Type: string
  • Default: No log file prefix

Optional log file prefix to use for the bucket's access logs.

If defined without "serverAccessLogsBucket", enables access logs to current bucket with this prefix.

transferAccelerationOptional 
public readonly transferAcceleration: boolean;
  • Type: boolean
  • Default: false

Whether this bucket should have transfer acceleration turned on or not.

versionedOptional 
public readonly versioned: boolean;
  • Type: boolean
  • Default: false

Whether this bucket should have versioning turned on or not.

websiteErrorDocumentOptional 
public readonly websiteErrorDocument: string;
  • Type: string
  • Default: No error document.

The name of the error document (e.g. "404.html") for the website. websiteIndexDocument must also be set if this is set.

websiteIndexDocumentOptional 
public readonly websiteIndexDocument: string;
  • Type: string
  • Default: No index document.

The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket.

websiteRedirectOptional 
public readonly websiteRedirect: RedirectTarget;
  • Type: aws-cdk-lib.aws_s3.RedirectTarget
  • Default: No redirection.

Specifies the redirect behavior of all requests to a website endpoint of a bucket.

If you specify this property, you can't specify "websiteIndexDocument", "websiteErrorDocument" nor , "websiteRoutingRules".

websiteRoutingRulesOptional 
public readonly websiteRoutingRules: RoutingRule[];
  • Type: aws-cdk-lib.aws_s3.RoutingRule[]
  • Default: No redirection rules.

Rules that define when a redirect is applied and the redirect behavior.

DailySpendsDigestProps

Properties for creating AWS resources to provide a daily spends digest analysis.

Initializer 

import { DailySpendsDigestProps } from '@cremich/cdk-bill-bot'

const dailySpendsDigestProps: DailySpendsDigestProps = { ... }

Properties

Name Type Description
datacatalog CostAndUsageDataCatalog A reference to your cost and usage data catalog.
slackWebHookUrl string The Slack webhook URL to send report results to.
datacatalogRequired 
public readonly datacatalog: CostAndUsageDataCatalog;

A reference to your cost and usage data catalog.

slackWebHookUrlRequired 
public readonly slackWebHookUrl: string;
  • Type: string

The Slack webhook URL to send report results to.

If this url is empty or invalid, the construct creation will fail with an error.

Enums

Compression

The compression format that AWS uses for the report.

Members

Name Description
ZIP Zip compression.
GZIP Gzip compression.
PARQUET Parquet compression.
ZIP

Zip compression.

GZIP

Gzip compression.

PARQUET

Parquet compression.

Format

The format that AWS saves the report in.

Members

Name Description
TEXT_OR_CSV Text or CSV format.
PARQUET Parquet format.
TEXT_OR_CSV

Text or CSV format.

PARQUET

Parquet format.

TimeUnit

The length of time covered by the report.

Members

Name Description
HOURLY Time covered per hour.
DAILY Time covered per day.
MONTHLY Time covered per month.
HOURLY

Time covered per hour.

DAILY

Time covered per day.

MONTHLY

Time covered per month.

Versioning

Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

Members

Name Description
CREATE_NEW_REPORT Create a new report version.
OVERWRITE_REPORT Overwrite existing report.
CREATE_NEW_REPORT

Create a new report version.

OVERWRITE_REPORT

Overwrite existing report.