Class S3Bucket
(experimental) An S3 bucket destination for data from a Kinesis Data Firehose delivery stream.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.KinesisFirehose.Destinations
Assembly: Amazon.CDK.AWS.KinesisFirehose.Destinations.dll
Syntax (csharp)
public class S3Bucket : DeputyBase, IDestination
Syntax (vb)
Public Class S3Bucket
Inherits DeputyBase
Implements IDestination
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
Bucket bucket;
// Provide a Lambda function that will transform records before delivery, with custom
// buffering and retry configuration
var lambdaFunction = new Function(this, "Processor", new FunctionProps {
Runtime = Runtime.NODEJS_14_X,
Handler = "index.handler",
Code = Code.FromAsset(Join(__dirname, "process-records"))
});
var lambdaProcessor = new LambdaFunctionProcessor(lambdaFunction, new DataProcessorProps {
BufferInterval = Duration.Minutes(5),
BufferSize = Size.Mebibytes(5),
Retries = 5
});
var s3Destination = new S3Bucket(bucket, new S3BucketProps {
Processor = lambdaProcessor
});
new DeliveryStream(this, "Delivery Stream", new DeliveryStreamProps {
Destinations = new [] { s3Destination }
});
Synopsis
Constructors
S3Bucket(IBucket, IS3BucketProps) | |
S3Bucket(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
S3Bucket(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
Bind(Construct, IDestinationBindOptions) | (experimental) Binds this destination to the Kinesis Data Firehose delivery stream. |
Constructors
S3Bucket(IBucket, IS3BucketProps)
public S3Bucket(IBucket bucket, IS3BucketProps props = null)
Parameters
- bucket IBucket
- props IS3BucketProps
Remarks
Stability: Experimental
S3Bucket(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected S3Bucket(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
S3Bucket(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected S3Bucket(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
Bind(Construct, IDestinationBindOptions)
(experimental) Binds this destination to the Kinesis Data Firehose delivery stream.
public virtual IDestinationConfig Bind(Construct scope, IDestinationBindOptions options)
Parameters
- scope Constructs.Construct
- options IDestinationBindOptions
Returns
Remarks
Implementers should use this method to bind resources to the stack and initialize values using the provided stream.
Stability: Experimental