Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(aws-cur): add error handling for CostReport construct outside us-east-1 #24

Merged
merged 6 commits into from
May 4, 2024
Merged

feat(aws-cur): add error handling for CostReport construct outside us-east-1 #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f7a7a41
feat: Add error handling when CUR is running outside the us-east-1 re…
tomoki10 May 4, 2024
824a064
docs: Explicitly specifies that it runs in the us-east-1
tomoki10 May 4, 2024
8cab41f
Update src/aws-cur/cost-report.ts
tomoki10 May 4, 2024
83075ee
chore: Explicitly specify us-east-1 as the only supported region
tomoki10 May 4, 2024
6ceb5dd
fix: Error messages to match the implementation
tomoki10 May 4, 2024
7f56c97
chore: Modify commented section
tomoki10 May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/aws-cur/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Here's how you can create a monthly cost and usage report in Parquet format:

```typescript
const app = new App();
const stack = new Stack(app, 'CostReportStack');
// Cannot specify regions other than us-east-1
const stack = new Stack(app, 'CostReportStack', { env: { region: 'us-east-1' } });
go-to-k marked this conversation as resolved.
Show resolved Hide resolved

new CostReport(stack, 'MyCostReport', {
costReportName: 'monthly-business-report',
Expand Down
8 changes: 6 additions & 2 deletions src/aws-cur/cost-report.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,17 @@ export class CostReport extends Construct {
constructor(scope: Construct, id: string, props: CostReportProps) {
super(scope, id);

const currentStack = Stack.of(this);

if (currentStack.region !== 'us-east-1') {
throw new Error(`The \`CostReport\` construct is only available in the us-east-1 region, got: ${currentStack.region} region`);
}

this.reportBucket = props.bucket ?? this.createReportBucket(this, 'Bucket', {
blockPublicAccess: aws_s3.BlockPublicAccess.BLOCK_ALL,
enforceSSL: true,
});

const currentStack = Stack.of(this);

const billingPrincipal = new aws_iam.ServicePrincipal('billingreports.amazonaws.com').withConditions({
StringEquals: {
'aws:SourceArn': `arn:aws:cur:${currentStack.region}:${currentStack.account}:definition/*`,
Expand Down
12 changes: 11 additions & 1 deletion test/aws-cur/cost-report.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ describe('CostReport', () => {

beforeEach(() => {
app = new App();
stack = new Stack(app, 'TestStack');
stack = new Stack(app, 'TestStack', { env: { region: 'us-east-1' } });
});

test('default configuration', () => {
Expand Down Expand Up @@ -112,4 +112,14 @@ describe('CostReport', () => {
template.resourceCountIs('AWS::CUR::ReportDefinition', 2);
});

test('regions other than us-east-1', () => {
const regionOtherStack = new Stack(app, 'OtherRegionStack', { env: { region: 'ap-northeast-1' } });

expect(() => new CostReport(regionOtherStack, 'MyCustomCostReport', {
costReportName: 'custom-cur',
reportGranularity: ReportGranularity.DAILY,
format: CurFormat.PARQUET,
})).toThrow(`The \`CostReport\` construct is only available in the us-east-1 region, got: ${regionOtherStack.region} region`);
});

});
2 changes: 1 addition & 1 deletion test/aws-cur/integ.cost-report.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import * as ocf from '../../src';

class CostReportStack extends cdk.Stack {
constructor(scope: Construct) {
super(scope, 'cur-report');
super(scope, 'cur-report', { env: { region: 'us-east-1' } });

const bucket = new cdk.aws_s3.Bucket(this, 'ReportBucket', {
removalPolicy: cdk.RemovalPolicy.DESTROY,
Expand Down
18 changes: 10 additions & 8 deletions test/aws-cur/integ.cost-report.ts.snapshot/cur-report.assets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,25 @@
"packaging": "zip"
},
"destinations": {
"current_account-current_region": {
"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
"current_account-us-east-1": {
"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-us-east-1",
"objectKey": "b7f33614a69548d6bafe224d751a7ef238cde19097415e553fe8b63a4c8fd8a6.zip",
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
"region": "us-east-1",
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-us-east-1"
}
}
},
"ae9c3c5ffd6c1730f1c1a6319554d1637fade1f5910c4e0e87bcdc05e3d42ce7": {
"ea273a55939f3c24361eca95307fd8752c4fee982b66f7fd4716f69bd89a7ed3": {
"source": {
"path": "cur-report.template.json",
"packaging": "file"
},
"destinations": {
"current_account-current_region": {
"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
"objectKey": "ae9c3c5ffd6c1730f1c1a6319554d1637fade1f5910c4e0e87bcdc05e3d42ce7.json",
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
"current_account-us-east-1": {
"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-us-east-1",
"objectKey": "ea273a55939f3c24361eca95307fd8752c4fee982b66f7fd4716f69bd89a7ed3.json",
"region": "us-east-1",
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-us-east-1"
}
}
}
Expand Down
18 changes: 4 additions & 14 deletions test/aws-cur/integ.cost-report.ts.snapshot/cur-report.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,7 @@
"Fn::Join": [
"",
[
"arn:aws:cur:",
{
"Ref": "AWS::Region"
},
":",
"arn:aws:cur:us-east-1:",
{
"Ref": "AWS::AccountId"
},
Expand Down Expand Up @@ -128,11 +124,7 @@
"Fn::Join": [
"",
[
"arn:aws:cur:",
{
"Ref": "AWS::Region"
},
":",
"arn:aws:cur:us-east-1:",
{
"Ref": "AWS::AccountId"
},
Expand Down Expand Up @@ -207,7 +199,7 @@
"Properties": {
"Code": {
"S3Bucket": {
"Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
"Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-us-east-1"
},
"S3Key": "b7f33614a69548d6bafe224d751a7ef238cde19097415e553fe8b63a4c8fd8a6.zip"
},
Expand Down Expand Up @@ -253,9 +245,7 @@
"Ref": "ReportBucket577F0FCD"
},
"S3Prefix": "reports",
"S3Region": {
"Ref": "AWS::Region"
},
"S3Region": "us-east-1",
"TimeUnit": "HOURLY"
},
"DependsOn": [
Expand Down
10 changes: 5 additions & 5 deletions test/aws-cur/integ.cost-report.ts.snapshot/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@
},
"cur-report": {
"type": "aws:cloudformation:stack",
"environment": "aws://unknown-account/unknown-region",
"environment": "aws://unknown-account/us-east-1",
"properties": {
"templateFile": "cur-report.template.json",
"terminationProtection": false,
"validateOnSynth": false,
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
"cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
"stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/ae9c3c5ffd6c1730f1c1a6319554d1637fade1f5910c4e0e87bcdc05e3d42ce7.json",
"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-us-east-1",
"cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-us-east-1",
"stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-us-east-1/ea273a55939f3c24361eca95307fd8752c4fee982b66f7fd4716f69bd89a7ed3.json",
"requiresBootstrapStackVersion": 6,
"bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
"additionalDependencies": [
"cur-report.assets"
],
"lookupRole": {
"arn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-lookup-role-${AWS::AccountId}-${AWS::Region}",
"arn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-lookup-role-${AWS::AccountId}-us-east-1",
"requiresBootstrapStackVersion": 8,
"bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version"
}
Expand Down
22 changes: 6 additions & 16 deletions test/aws-cur/integ.cost-report.ts.snapshot/tree.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,7 @@
"Fn::Join": [
"",
[
"arn:aws:cur:",
{
"Ref": "AWS::Region"
},
":",
"arn:aws:cur:us-east-1:",
{
"Ref": "AWS::AccountId"
},
Expand Down Expand Up @@ -153,11 +149,7 @@
"Fn::Join": [
"",
[
"arn:aws:cur:",
{
"Ref": "AWS::Region"
},
":",
"arn:aws:cur:us-east-1:",
{
"Ref": "AWS::AccountId"
},
Expand Down Expand Up @@ -277,9 +269,7 @@
"Ref": "ReportBucket577F0FCD"
},
"s3Prefix": "reports",
"s3Region": {
"Ref": "AWS::Region"
},
"s3Region": "us-east-1",
"timeUnit": "HOURLY"
}
},
Expand All @@ -291,7 +281,7 @@
},
"constructInfo": {
"fqn": "constructs.Construct",
"version": "10.0.5"
"version": "10.3.0"
}
},
"BootstrapVersion": {
Expand Down Expand Up @@ -329,7 +319,7 @@
"path": "CurReport/DefaultTest/Default",
"constructInfo": {
"fqn": "constructs.Construct",
"version": "10.0.5"
"version": "10.3.0"
}
},
"DeployAssert": {
Expand Down Expand Up @@ -375,7 +365,7 @@
"path": "Tree",
"constructInfo": {
"fqn": "constructs.Construct",
"version": "10.0.5"
"version": "10.3.0"
}
}
},
Expand Down