aws-kinesisfirehose-s3 module
This is a developer preview (public beta) module.
All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. 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.
| API Reference: | http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-kinesisfirehose-s3/ |
|---|
| Language | Package |
|---|---|
 {: style="height:16px;width:16px"} Python |
aws_solutions_konstruk.aws_kinesisfirehose_s3 |
 {: style="height:16px;width:16px"} Typescript |
@aws-solutions-konstruk/aws-kinesisfirehose-s3 |
This AWS Solutions Konstruk implements an Amazon Kinesis Data Firehose delivery stream connected to an Amazon S3 bucket.
Here is a minimal deployable pattern definition:
const { KinesisFirehoseToS3 } = require('@aws-solutions-konstruk/aws-kinesisfirehose-s3');
new KinesisFirehoseToS3(stack, 'test-firehose-s3', {});Initializer
new KinesisFirehoseToS3(scope: Construct, id: string, props: KinesisFirehoseToS3Props);
Parameters
- scope
Construct - id
string - props
KinesisFirehoseToS3Props
Pattern Construct Props
| Name | Type | Description |
|---|---|---|
| kinesisFirehoseProps? | kinesisfirehose.CfnDeliveryStreamProps |
Optional user provided props to override the default props for Kinesis Firehose Delivery Stream |
| deployBucket? | boolean |
Whether to create a S3 Bucket or use an existing S3 Bucket |
| existingBucketObj? | s3.Bucket |
Existing instance of S3 Bucket object |
| bucketProps? | s3.BucketProps |
Optional user provided props to override the default props for S3 Bucket |
Pattern Properties
| Name | Type | Description |
|---|---|---|
| kinesisFirehose() | kinesisfirehose.CfnDeliveryStream |
Returns an instance of kinesisfirehose.CfnDeliveryStream created by the construct |
| bucket() | s3.Bucket |
Returns an instance of s3.Bucket created by the construct |
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.