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

Interface ApplicationProps

All Known Implementing Classes:

ApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:28.870Z")
public interface ApplicationProps

(experimental) Props for creating an Application construct.

Example:

 import path.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.services.kinesis.analytics.flink.*;
 import software.amazon.awscdk.services.cloudwatch.*;
 App app = new App();
 Stack stack = new Stack(app, "FlinkAppTest");
 Application flinkApp = Application.Builder.create(stack, "App")
         .code(ApplicationCode.fromAsset(join(__dirname, "code-asset")))
         .runtime(Runtime.FLINK_1_11)
         .build();
 Alarm.Builder.create(stack, "Alarm")
         .metric(flinkApp.metricFullRestarts())
         .evaluationPeriods(1)
         .threshold(3)
         .build();
 app.synth();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApplicationProps.Builder A builder for ApplicationProps
static class	ApplicationProps.Jsii$Proxy An implementation for ApplicationProps

Method Summary

Modifier and Type	Method and Description
static ApplicationProps.Builder	builder()
default java.lang.String	getApplicationName() (experimental) A name for your Application that is unique to an AWS account.
default java.lang.Boolean	getAutoScalingEnabled() (experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.
default java.lang.Boolean	getCheckpointingEnabled() (experimental) Whether checkpointing is enabled while your application runs.
default Duration	getCheckpointInterval() (experimental) The interval between checkpoints.
ApplicationCode	getCode() (experimental) The Flink code asset to run.
default ILogGroup	getLogGroup() (experimental) The log group to send log entries to.
default LogLevel	getLogLevel() (experimental) The level of log verbosity from the Flink application.
default MetricsLevel	getMetricsLevel() (experimental) Describes the granularity of the CloudWatch metrics for an application.
default Duration	getMinPauseBetweenCheckpoints() (experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.
default java.lang.Number	getParallelism() (experimental) The initial parallelism for the application.
default java.lang.Number	getParallelismPerKpu() (experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).
default PropertyGroups	getPropertyGroups() (experimental) Configuration PropertyGroups.
default RemovalPolicy	getRemovalPolicy() (experimental) Provide a RemovalPolicy to override the default.
default IRole	getRole() (experimental) A role to use to grant permissions to your application.
Runtime	getRuntime() (experimental) The Flink version to use for this application.
default java.lang.Boolean	getSnapshotsEnabled() (experimental) Determines if Flink snapshots are enabled.

Method Detail

getCode

ApplicationCode getCode()

(experimental) The Flink code asset to run.

getRuntime

Runtime getRuntime()

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

getApplicationName

default java.lang.String getApplicationName()

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

Default: - CloudFormation-generated name

getAutoScalingEnabled

default java.lang.Boolean getAutoScalingEnabled()

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

Default: true

getCheckpointingEnabled

default java.lang.Boolean getCheckpointingEnabled()

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

Default: true

getCheckpointInterval

default Duration getCheckpointInterval()

(experimental) The interval between checkpoints.

Default: 1 minute

getLogGroup

default ILogGroup getLogGroup()

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

Default: CDK's default LogGroup

getLogLevel

default LogLevel getLogLevel()

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

Default: FlinkLogLevel.INFO

getMetricsLevel

default MetricsLevel getMetricsLevel()

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

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

getMinPauseBetweenCheckpoints

default Duration getMinPauseBetweenCheckpoints()

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

Default: 5 seconds

getParallelism

default java.lang.Number getParallelism()

(experimental) The initial parallelism for the application.

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

Default: 1

getParallelismPerKpu

default java.lang.Number getParallelismPerKpu()

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

Default: 1

getPropertyGroups

default PropertyGroups getPropertyGroups()

(experimental) Configuration PropertyGroups.

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

getRemovalPolicy

default RemovalPolicy getRemovalPolicy()

(experimental) Provide a RemovalPolicy to override the default.

Default: RemovalPolicy.DESTROY

getRole

default IRole getRole()

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

Prefer omitting this property and using the default role.

Default: - a new Role will be created

getSnapshotsEnabled

default java.lang.Boolean getSnapshotsEnabled()

(experimental) Determines if Flink snapshots are enabled.

Default: true

builder

static ApplicationProps.Builder builder()

Returns:

a ApplicationProps.Builder of ApplicationProps