Skip navigation links

Package software.amazon.awscdk.services.kinesis.analytics.flink

Kinesis Analytics Flink

See: Description

Package software.amazon.awscdk.services.kinesis.analytics.flink Description

Kinesis Analytics Flink

---

cdk-constructs: Experimental

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 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.


This package provides constructs for creating Kinesis Analytics Flink applications. To learn more about using using managed Flink applications, see the AWS developer guide.

Creating Flink Applications

To create a new Flink application, use the Application construct:

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 import path.*;
 import software.amazon.awscdk.core.*;
 import lib.*;
 
 App app = new App();
 Stack stack = new Stack(app, "FlinkAppTest");
 
 new Application(stack, "App", new ApplicationProps()
         .code(flink.ApplicationCode.fromAsset(path.join(__dirname, "code-asset")))
         .runtime(flink.Runtime.getFLINK_1_11()));
 
 app.synth();
 

The code property can use fromAsset as shown above to reference a local jar file in s3 or fromBucket to reference a file in s3.

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 import path.*;
 import software.amazon.awscdk.services.s3.assets.*;
 import software.amazon.awscdk.core.*;
 import lib.*;
 
 App app = new App();
 Stack stack = new Stack(app, "FlinkAppCodeFromBucketTest");
 
 Asset asset = new Asset(stack, "CodeAsset", new AssetProps()
         .path(path.join(__dirname, "code-asset")));
 IBucket bucket = asset.getBucket();
 String fileKey = asset.getS3ObjectKey();
 
 new Application(stack, "App", new ApplicationProps()
         .code(flink.ApplicationCode.fromBucket(bucket, fileKey))
         .runtime(flink.Runtime.getFLINK_1_11()));
 
 app.synth();
 

The propertyGroups property provides a way of passing arbitrary runtime properties to your Flink application. You can use the aws-kinesisanalytics-runtime library to retrieve these properties.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.kinesis.analytics.flink.*;
 
 Application flinkApp = new Application(this, "Application", new ApplicationProps()
         // ...
         .propertyGroups(new PropertyGroups()
                 .FlinkApplicationProperties(Map.of(
                         "inputStreamName", "my-input-kinesis-stream",
                         "outputStreamName", "my-output-kinesis-stream"))));
 

Flink applications also have specific configuration for passing parameters when the Flink job starts. These include parameters for checkpointing, snapshotting, monitoring, and parallelism.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.logs.*;
 
 Object flinkApp = Application.Builder.create(this, "Application")
         .code(flink.ApplicationCode.fromBucket(bucket, "my-app.jar"))
         .runtime(file.Runtime.getFLINK_1_11())
         .checkpointingEnabled(true)// default is true
         .checkpointInterval(cdk.Duration.seconds(30))// default is 1 minute
         .minPausesBetweenCheckpoints(cdk.Duration.seconds(10))// default is 5 seconds
         .logLevel(flink.LogLevel.getERROR())// default is INFO
         .metricsLevel(flink.MetricsLevel.getPARALLELISM())// default is APPLICATION
         .autoScalingEnabled(false)// default is true
         .parallelism(32)// default is 1
         .parallelismPerKpu(2)// default is 1
         .snapshotsEnabled(false)// default is true
         .logGroup(new LogGroup(this, "LogGroup"))
         .build();
 
Skip navigation links