Interface IApplicationProps

(experimental) Props for creating an Application construct.

Namespace: Amazon.CDK.AWS.Kinesisanalytics.Flink.Alpha

Assembly: Amazon.CDK.AWS.KinesisAnalyticsFlink.Alpha.dll

Syntax (csharp)

public interface IApplicationProps

Syntax (vb)

Public Interface IApplicationProps

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

Bucket bucket;

             var flinkApp = new Application(this, "Application", new ApplicationProps {
                 PropertyGroups = new Dictionary<string, IDictionary<string, string>> {
                     { "FlinkApplicationProperties", new Dictionary<string, string> {
                         { "inputStreamName", "my-input-kinesis-stream" },
                         { "outputStreamName", "my-output-kinesis-stream" }
                     } }
                 },
                 // ...
                 Runtime = Runtime.FLINK_1_20,
                 Code = ApplicationCode.FromBucket(bucket, "my-app.jar")
             });

Synopsis

Properties

ApplicationName	(experimental) A name for your Application that is unique to an AWS account.
AutoScalingEnabled	(experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.
CheckpointInterval	(experimental) The interval between checkpoints.
CheckpointingEnabled	(experimental) Whether checkpointing is enabled while your application runs.
Code	(experimental) The Flink code asset to run.
LogGroup	(experimental) The log group to send log entries to.
LogLevel	(experimental) The level of log verbosity from the Flink application.
MetricsLevel	(experimental) Describes the granularity of the CloudWatch metrics for an application.
MinPauseBetweenCheckpoints	(experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.
Parallelism	(experimental) The initial parallelism for the application.
ParallelismPerKpu	(experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).
PropertyGroups	(experimental) Configuration PropertyGroups.
RemovalPolicy	(experimental) Provide a RemovalPolicy to override the default.
Role	(experimental) A role to use to grant permissions to your application.
Runtime	(experimental) The Flink version to use for this application.
SecurityGroups	(experimental) Security groups to use with a provided VPC.
SnapshotsEnabled	(experimental) Determines if Flink snapshots are enabled.
Vpc	(experimental) Deploy the Flink application in a VPC.
VpcSubnets	(experimental) Choose which VPC subnets to use.

Properties

ApplicationName

(experimental) A name for your Application that is unique to an AWS account.

string? ApplicationName { get; }

Property Value

string

Remarks

Default: - CloudFormation-generated name

Stability: Experimental

AutoScalingEnabled

(experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.

bool? AutoScalingEnabled { get; }

Property Value

bool?

Remarks

Default: true

Stability: Experimental

CheckpointInterval

(experimental) The interval between checkpoints.

Duration? CheckpointInterval { get; }

Property Value

Duration

Remarks

Default: - 1 minute

Stability: Experimental

CheckpointingEnabled

(experimental) Whether checkpointing is enabled while your application runs.

bool? CheckpointingEnabled { get; }

Property Value

bool?

Remarks

Default: true

Stability: Experimental

Code

(experimental) The Flink code asset to run.

ApplicationCode Code { get; }

Property Value

ApplicationCode

Remarks

Stability: Experimental

LogGroup

(experimental) The log group to send log entries to.

ILogGroup? LogGroup { get; }

Property Value

ILogGroup

Remarks

Default: - CDK's default LogGroup

Stability: Experimental

LogLevel

(experimental) The level of log verbosity from the Flink application.

LogLevel? LogLevel { get; }

Property Value

LogLevel?

Remarks

Default: FlinkLogLevel.INFO

Stability: Experimental

MetricsLevel

(experimental) Describes the granularity of the CloudWatch metrics for an application.

MetricsLevel? MetricsLevel { get; }

Property Value

MetricsLevel?

Remarks

Use caution with Parallelism level metrics. Parallelism granularity logs metrics for each parallel thread and can quickly become expensive when parallelism is high (e.g. > 64).

Default: MetricsLevel.APPLICATION

Stability: Experimental

MinPauseBetweenCheckpoints

(experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.

Duration? MinPauseBetweenCheckpoints { get; }

Property Value

Duration

Remarks

Default: - 5 seconds

Stability: Experimental

Parallelism

(experimental) The initial parallelism for the application.

double? Parallelism { get; }

Property Value

double?

Remarks

Kinesis Data Analytics can stop the app, increase the parallelism, and start the app again if autoScalingEnabled is true (the default value).

Default: 1

Stability: Experimental

ParallelismPerKpu

(experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).

double? ParallelismPerKpu { get; }

Property Value

double?

Remarks

Default: 1

Stability: Experimental

PropertyGroups

(experimental) Configuration PropertyGroups.

IDictionary<string, IDictionary<string, string>>? PropertyGroups { get; }

Property Value

IDictionary<string, IDictionary<string, string>>

Remarks

You can use these property groups to pass arbitrary runtime configuration values to your Flink app.

Default: - No property group configuration provided to the Flink app

Stability: Experimental

RemovalPolicy

(experimental) Provide a RemovalPolicy to override the default.

RemovalPolicy? RemovalPolicy { get; }

Property Value

RemovalPolicy?

Remarks

Default: RemovalPolicy.DESTROY

Stability: Experimental

Role

(experimental) A role to use to grant permissions to your application.

IRole? Role { get; }

Property Value

IRole

Remarks

Prefer omitting this property and using the default role.

Default: - a new Role will be created

Stability: Experimental

Runtime

(experimental) The Flink version to use for this application.

Runtime Runtime { get; }

Property Value

Runtime

Remarks

Stability: Experimental

SecurityGroups

(experimental) Security groups to use with a provided VPC.

ISecurityGroup[]? SecurityGroups { get; }

Property Value

ISecurityGroup[]

Remarks

Default: - a new security group is created for this application.

Stability: Experimental

SnapshotsEnabled

(experimental) Determines if Flink snapshots are enabled.

bool? SnapshotsEnabled { get; }

Property Value

bool?

Remarks

Default: true

Stability: Experimental

Vpc

(experimental) Deploy the Flink application in a VPC.

IVpc? Vpc { get; }

Property Value

IVpc

Remarks

Default: - no VPC

Stability: Experimental

VpcSubnets

(experimental) Choose which VPC subnets to use.

ISubnetSelection? VpcSubnets { get; }

Property Value

ISubnetSelection

Remarks

Default: - SubnetType.PRIVATE_WITH_EGRESS subnets

Stability: Experimental