Class ApplicationProps
(experimental) Props for creating an Application construct.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.KinesisAnalyticsFlink
Assembly: Amazon.CDK.AWS.KinesisAnalyticsFlink.dll
Syntax (csharp)
public class ApplicationProps : Object, IApplicationProps
Syntax (vb)
Public Class ApplicationProps
Inherits Object
Implements IApplicationProps
Remarks
Stability: Experimental
ExampleMetadata: lit=test/integ.application.lit.ts ! show infused
Examples
using Path;
using Amazon.CDK;
using Amazon.CDK.AWS.KinesisAnalyticsFlink;
using Amazon.CDK.AWS.CloudWatch;
var app = new App();
var stack = new Stack(app, "FlinkAppTest");
var flinkApp = new Application(stack, "App", new ApplicationProps {
Code = ApplicationCode.FromAsset(Join(__dirname, "code-asset")),
Runtime = Runtime.FLINK_1_11
});
new Alarm(stack, "Alarm", new AlarmProps {
Metric = flinkApp.MetricFullRestarts(),
EvaluationPeriods = 1,
Threshold = 3
});
app.Synth();
Synopsis
Constructors
ApplicationProps() |
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. |
CheckpointingEnabled | (experimental) Whether checkpointing is enabled while your application runs. |
CheckpointInterval | (experimental) The interval between checkpoints. |
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. |
SnapshotsEnabled | (experimental) Determines if Flink snapshots are enabled. |
Constructors
ApplicationProps()
public ApplicationProps()
Properties
ApplicationName
(experimental) A name for your Application that is unique to an AWS account.
public string ApplicationName { get; set; }
Property Value
System.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.
public Nullable<bool> AutoScalingEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
CheckpointingEnabled
(experimental) Whether checkpointing is enabled while your application runs.
public Nullable<bool> CheckpointingEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
CheckpointInterval
(experimental) The interval between checkpoints.
public Duration CheckpointInterval { get; set; }
Property Value
Remarks
Default: 1 minute
Stability: Experimental
Code
(experimental) The Flink code asset to run.
public ApplicationCode Code { get; set; }
Property Value
Remarks
Stability: Experimental
LogGroup
(experimental) The log group to send log entries to.
public ILogGroup LogGroup { get; set; }
Property Value
Remarks
Default: CDK's default LogGroup
Stability: Experimental
LogLevel
(experimental) The level of log verbosity from the Flink application.
public Nullable<LogLevel> LogLevel { get; set; }
Property Value
System.Nullable<LogLevel>
Remarks
Default: FlinkLogLevel.INFO
Stability: Experimental
MetricsLevel
(experimental) Describes the granularity of the CloudWatch metrics for an application.
public Nullable<MetricsLevel> MetricsLevel { get; set; }
Property Value
System.Nullable<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.
public Duration MinPauseBetweenCheckpoints { get; set; }
Property Value
Remarks
Default: 5 seconds
Stability: Experimental
Parallelism
(experimental) The initial parallelism for the application.
public Nullable<double> Parallelism { get; set; }
Property Value
System.Nullable<System.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).
public Nullable<double> ParallelismPerKpu { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
Stability: Experimental
PropertyGroups
(experimental) Configuration PropertyGroups.
public IPropertyGroups PropertyGroups { get; set; }
Property Value
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.
public Nullable<RemovalPolicy> RemovalPolicy { get; set; }
Property Value
System.Nullable<RemovalPolicy>
Remarks
Default: RemovalPolicy.DESTROY
Stability: Experimental
Role
(experimental) A role to use to grant permissions to your application.
public IRole Role { get; set; }
Property Value
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.
public Runtime Runtime { get; set; }
Property Value
Remarks
Stability: Experimental
SnapshotsEnabled
(experimental) Determines if Flink snapshots are enabled.
public Nullable<bool> SnapshotsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental