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.

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-kinesisfirehose): DeliveryStream API and basic S3 destination #15544

Merged
merged 58 commits into from
Jul 23, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
8401fb4
feat(aws-kinesisfirehose): DeliveryStream API and basic S3 destination
madeline-k Jul 14, 2021
dca12f2
fix typo in aws-kinesisfirehose-destinations README
madeline-k Jul 14, 2021
6fceebf
remove unnecessary deps
madeline-k Jul 14, 2021
7892f58
Merge branch 'master' into madeline-k/feat/kinesisfirehose-deliveryst…
madeline-k Jul 14, 2021
78e6a9c
remove awslint exception for IConnectable.connections
madeline-k Jul 15, 2021
5f7a15c
Change name of S3 destination to S3Bucket
madeline-k Jul 15, 2021
efe2fe0
add Role to DestinationBindOptions, update S3 to S3Bucket in tests
madeline-k Jul 15, 2021
4308f44
remove helper function to enforce ExtendedS3DestinationConfigurationP…
madeline-k Jul 15, 2021
172ab43
remove lambda dependency
madeline-k Jul 15, 2021
c0d85f5
update README
madeline-k Jul 15, 2021
3d34c46
remove tagsand ITaggable interface
madeline-k Jul 15, 2021
5ceff5c
use splitArn instead of parseArn
madeline-k Jul 15, 2021
ce4dde1
update error message for bad input ARN
madeline-k Jul 15, 2021
0ed658f
add ArnFormat to formatArn() call
madeline-k Jul 15, 2021
1925560
update error message in tests for bad input ARN
madeline-k Jul 15, 2021
e46c595
pass deliveryStreamName as physicalName through to super constructor
madeline-k Jul 15, 2021
d1463a2
move validation to beginning of constructor
madeline-k Jul 15, 2021
1623199
simplify createLoggingOptions
madeline-k Jul 15, 2021
16a54e5
remove awslint exclude
madeline-k Jul 15, 2021
b011392
feat(aws-kinesisfirehose): specific metrics functions for DeliveryStr…
madeline-k Jul 16, 2021
56aa16a
change name of s3 destination props to S3BucketProps
BenChaimberg Jul 17, 2021
f70fc31
remove basic s3 integration test
BenChaimberg Jul 17, 2021
73f1777
rename integration tests
BenChaimberg Jul 17, 2021
314c4ca
de-exports DeliveryStreamBase
BenChaimberg Jul 17, 2021
64131d1
leverage construct tree to store LogGroup and prevent creating it mul…
madeline-k Jul 17, 2021
6c78eeb
Revert "feat(aws-kinesisfirehose): specific metrics functions for Del…
madeline-k Jul 17, 2021
ccd9333
cleanup s3 destination unit tests to do less hardcoding
BenChaimberg Jul 17, 2021
e37d8ea
make snippets compile and enforce strict compilation
BenChaimberg Jul 17, 2021
cd1618b
remove IDeliveryStream from DestinationBindOptions, only service role…
BenChaimberg Jul 17, 2021
bfe6dd4
remove explicit dependency delivery stream -> service role
BenChaimberg Jul 17, 2021
dcd088d
Revert "remove explicit dependency delivery stream -> service role"
BenChaimberg Jul 17, 2021
0a7e010
destination has separate role
BenChaimberg Jul 17, 2021
c99c242
update @types/jest dependency to match all other modules
madeline-k Jul 19, 2021
157d3ca
loose snippet compilation to avoid cyclic dependency
BenChaimberg Jul 19, 2021
49c184d
Merge remote-tracking branch 'origin/master' into madeline-k/feat/kin…
BenChaimberg Jul 19, 2021
db9ea21
update README
madeline-k Jul 19, 2021
49a839e
Use L1 types in DestinationConfig returned from bind()
madeline-k Jul 19, 2021
a2c85bd
remove DestinationBase, move createLoggingOptions and DestinationProps
BenChaimberg Jul 19, 2021
569ca01
don't pass role into bind()
madeline-k Jul 19, 2021
a307108
feat(kinesisfirehose): destinations can provide resources to be depen…
BenChaimberg Jul 20, 2021
04d5ae7
remove unused custom-resources dependency
BenChaimberg Jul 20, 2021
93cc0e5
rewrite providing IAM role section (include separate destination role…
BenChaimberg Jul 21, 2021
3aa77bd
add more IAM role detail
BenChaimberg Jul 21, 2021
7883929
snapshot spacing
BenChaimberg Jul 21, 2021
1c65da6
Merge remote-tracking branch 'origin/master' into madeline-k/feat/kin…
BenChaimberg Jul 21, 2021
45fec81
make s3 destination props readonly
BenChaimberg Jul 21, 2021
28c120f
line length linting
BenChaimberg Jul 21, 2021
005402c
do not re-use log group if log group provided in props
BenChaimberg Jul 21, 2021
0f9d42d
rename DestinationProps -> CommonDestinationProps
BenChaimberg Jul 21, 2021
ed02d9f
move logging tests to S3 bucket destination
BenChaimberg Jul 21, 2021
c6a8553
Merge branch 'master' into madeline-k/feat/kinesisfirehose-deliveryst…
madeline-k Jul 22, 2021
2bcc663
Merge branch 'master' of github.com:aws/aws-cdk into madeline-k/feat/…
BenChaimberg Jul 22, 2021
98d6371
use new lazy mappings for CIDR blocks
BenChaimberg Jul 22, 2021
e006441
update S3 -> S3Bucket class name in default.ts-fixture
madeline-k Jul 22, 2021
86c7cb7
Apply suggestions from code review
madeline-k Jul 22, 2021
f8b03c4
remove private index.ts
madeline-k Jul 22, 2021
8c2903e
hardcode logical IDs in unit tests
madeline-k Jul 22, 2021
efb6eee
Merge branch 'master' into madeline-k/feat/kinesisfirehose-deliveryst…
madeline-k Jul 22, 2021
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: 3 additions & 0 deletions packages/@aws-cdk/aws-ec2/lib/connections.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import { ISecurityGroup } from './security-group';
* An object that has a Connections object
*/
export interface IConnectable {
/**
* The network connections associated with this resource.
*/
madeline-k marked this conversation as resolved.
Show resolved Hide resolved
readonly connections: Connections;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
const baseConfig = require('cdk-build-tools/config/eslintrc');
baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
module.exports = baseConfig;
19 changes: 19 additions & 0 deletions packages/@aws-cdk/aws-kinesisfirehose-destinations/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
*.js
tsconfig.json
*.js.map
*.d.ts
*.generated.ts
dist
lib/generated/resources.ts
.jsii

.LAST_BUILD
.nyc_output
coverage
nyc.config.js
.LAST_PACKAGE
*.snk
!.eslintrc.js
!jest.config.js

junit.xml
28 changes: 28 additions & 0 deletions packages/@aws-cdk/aws-kinesisfirehose-destinations/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Don't include original .ts files when doing `npm pack`
*.ts
!*.d.ts
coverage
.nyc_output
*.tgz

dist
.LAST_PACKAGE
.LAST_BUILD
!*.js

# Include .jsii
!.jsii

*.snk

*.tsbuildinfo

tsconfig.json
.eslintrc.js
jest.config.js

# exclude cdk artifacts
**/cdk.out
junit.xml
test/
!*.lit.ts
201 changes: 201 additions & 0 deletions packages/@aws-cdk/aws-kinesisfirehose-destinations/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2 changes: 2 additions & 0 deletions packages/@aws-cdk/aws-kinesisfirehose-destinations/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
AWS Cloud Development Kit (AWS CDK)
Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22 changes: 22 additions & 0 deletions packages/@aws-cdk/aws-kinesisfirehose-destinations/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Amazon Kinesis Data Firehose Destinations Library
<!--BEGIN STABILITY BANNER-->

---

![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)

> The APIs of higher level constructs in this module are experimental and under active development.
> They are subject to non-backward compatible changes or removal in any future version. These are
> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
> announced in the release notes. This means that while you may use them, you may need to update
> your source code when upgrading to a newer version of this package.

---

<!--END STABILITY BANNER-->

This library provides constructs for adding destinations to a Amazon Kinesis Data Firehose
delivery stream. Destinations can be added by specifying the `destinations` prop when
defining a delivery stream.

See [Amazon Kinesis Data Firehose module README](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-kinesisfirehose-readme.html) for usage examples.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
const baseConfig = require('cdk-build-tools/config/jest.config');
module.exports = baseConfig;
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './s3';
39 changes: 39 additions & 0 deletions packages/@aws-cdk/aws-kinesisfirehose-destinations/lib/s3.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import * as iam from '@aws-cdk/aws-iam';
import * as firehose from '@aws-cdk/aws-kinesisfirehose';
import { CfnDeliveryStream } from '@aws-cdk/aws-kinesisfirehose';
import * as s3 from '@aws-cdk/aws-s3';
import { Construct } from 'constructs';

/**
* Props for defining an S3 destination of a Kinesis Data Firehose delivery stream.
*/
export interface S3Props extends firehose.DestinationProps { }

/**
* An S3 bucket destination for data from a Kinesis Data Firehose delivery stream.
*/
export class S3 extends firehose.DestinationBase {
BenChaimberg marked this conversation as resolved.
Show resolved Hide resolved
constructor(private readonly bucket: s3.IBucket, s3Props: S3Props = {}) {
super(s3Props);
}

bind(scope: Construct, options: firehose.DestinationBindOptions): firehose.DestinationConfig {
return {
properties: {
extendedS3DestinationConfiguration: this.createExtendedS3DestinationConfiguration(scope, options.deliveryStream),
},
};
}

private createExtendedS3DestinationConfiguration(
scope: Construct,
deliveryStream: firehose.IDeliveryStream,
): CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty {
this.bucket.grantReadWrite(deliveryStream);
return {
cloudWatchLoggingOptions: this.createLoggingOptions(scope, deliveryStream, 'S3Destination'),
roleArn: (deliveryStream.grantPrincipal as iam.IRole).roleArn,
BenChaimberg marked this conversation as resolved.
Show resolved Hide resolved
bucketArn: this.bucket.bucketArn,
};
}
BenChaimberg marked this conversation as resolved.
Show resolved Hide resolved
}
Loading