Package software.amazon.awscdk.services.kinesisfirehose.destinations

Class Compression

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kinesisfirehose.destinations.Compression

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:41.945Z")
@Stability(Experimental)
public class Compression
extends software.amazon.jsii.JsiiObject

(experimental) Possible compression options Kinesis Data Firehose can use to compress data on delivery.

Example:

 import path.*;
 import software.amazon.awscdk.services.kinesisfirehose.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.lambda.nodejs.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.services.kinesisfirehose.destinations.*;
 App app = new App();
 Stack stack = new Stack(app, "aws-cdk-firehose-delivery-stream-s3-all-properties");
 Bucket bucket = Bucket.Builder.create(stack, "Bucket")
         .removalPolicy(RemovalPolicy.DESTROY)
         .autoDeleteObjects(true)
         .build();
 Bucket backupBucket = Bucket.Builder.create(stack, "BackupBucket")
         .removalPolicy(RemovalPolicy.DESTROY)
         .autoDeleteObjects(true)
         .build();
 LogGroup logGroup = LogGroup.Builder.create(stack, "LogGroup")
         .removalPolicy(RemovalPolicy.DESTROY)
         .build();
 NodejsFunction dataProcessorFunction = NodejsFunction.Builder.create(stack, "DataProcessorFunction")
         .entry(join(__dirname, "lambda-data-processor.js"))
         .timeout(Duration.minutes(1))
         .build();
 LambdaFunctionProcessor processor = LambdaFunctionProcessor.Builder.create(dataProcessorFunction)
         .bufferInterval(Duration.seconds(60))
         .bufferSize(Size.mebibytes(1))
         .retries(1)
         .build();
 Key key = Key.Builder.create(stack, "Key")
         .removalPolicy(RemovalPolicy.DESTROY)
         .build();
 Key backupKey = Key.Builder.create(stack, "BackupKey")
         .removalPolicy(RemovalPolicy.DESTROY)
         .build();
 DeliveryStream.Builder.create(stack, "Delivery Stream")
         .destinations(List.of(S3Bucket.Builder.create(bucket)
                 .logging(true)
                 .logGroup(logGroup)
                 .processor(processor)
                 .compression(Compression.GZIP)
                 .dataOutputPrefix("regularPrefix")
                 .errorOutputPrefix("errorPrefix")
                 .bufferingInterval(Duration.seconds(60))
                 .bufferingSize(Size.mebibytes(1))
                 .encryptionKey(key)
                 .s3Backup(DestinationS3BackupProps.builder()
                         .mode(BackupMode.ALL)
                         .bucket(backupBucket)
                         .compression(Compression.ZIP)
                         .dataOutputPrefix("backupPrefix")
                         .errorOutputPrefix("backupErrorPrefix")
                         .bufferingInterval(Duration.seconds(60))
                         .bufferingSize(Size.mebibytes(1))
                         .encryptionKey(backupKey)
                         .build())
                 .build()))
         .build();
 app.synth();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static final Compression	GZIP	(experimental) gzip.
static final Compression	HADOOP_SNAPPY	(experimental) Hadoop-compatible Snappy.
static final Compression	SNAPPY	(experimental) Snappy.
static final Compression	ZIP	(experimental) ZIP.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Compression(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Compression(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getValue()	(experimental) the string value of the Compression.
static Compression	of(String value)	(experimental) Creates a new Compression instance with a custom value.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

GZIP

@Stability(Experimental)
public static final Compression GZIP

(experimental) gzip.

HADOOP_SNAPPY

@Stability(Experimental)
public static final Compression HADOOP_SNAPPY

(experimental) Hadoop-compatible Snappy.

SNAPPY

@Stability(Experimental)
public static final Compression SNAPPY

(experimental) Snappy.

ZIP

@Stability(Experimental)
public static final Compression ZIP

(experimental) ZIP.

Constructor Details

Compression

protected Compression(software.amazon.jsii.JsiiObjectRef objRef)

Compression

protected Compression(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Details

of

@Stability(Experimental)
@NotNull
public static Compression of(@NotNull
 String value)

(experimental) Creates a new Compression instance with a custom value.

Parameters:

value - This parameter is required.

getValue

@Stability(Experimental)
@NotNull
public String getValue()

(experimental) the string value of the Compression.