Class Application
(experimental) The L2 construct for Flink Kinesis Data Applications.
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisAnalyticsFlink
Assembly: Amazon.CDK.AWS.KinesisAnalyticsFlink.dll
Syntax (csharp)
public class Application : Resource, IApplication, IResource, IConstruct, IDependable, IGrantable
Syntax (vb)
Public Class Application
Inherits Resource
Implements IApplication, IResource, IConstruct, IDependable, IGrantable
Remarks
Stability: Experimental
Resource: AWS::KinesisAnalyticsV2::Application
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
Application(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Application(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Application(Construct, String, IApplicationProps) |
Properties
ApplicationArn | (experimental) The application ARN. |
ApplicationName | (experimental) The name of the Flink application. |
GrantPrincipal | (experimental) The principal to grant permissions to. |
Role | (experimental) The application IAM role. |
Methods
AddToRolePolicy(PolicyStatement) | (experimental) Implement the convenience {@link IApplication.addToPrincipalPolicy} method. |
FromApplicationArn(Construct, String, String) | (experimental) Import an existing application defined outside of CDK code by applicationArn. |
FromApplicationName(Construct, String, String) | (experimental) Import an existing Flink application defined outside of CDK code by applicationName. |
Metric(String, IMetricOptions) | (experimental) Return a CloudWatch metric associated with this Flink application. |
MetricBackPressuredTimeMsPerSecond(IMetricOptions) | (experimental) The time (in milliseconds) this task or operator is back pressured per second. |
MetricBusyTimePerMsPerSecond(IMetricOptions) | (experimental) The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second. |
MetricCpuUtilization(IMetricOptions) | (experimental) The overall percentage of CPU utilization across task managers. |
MetricCurrentInputWatermark(IMetricOptions) | (experimental) The last watermark this application/operator/task/thread has received. |
MetricCurrentOutputWatermark(IMetricOptions) | (experimental) The last watermark this application/operator/task/thread has received. |
MetricDowntime(IMetricOptions) | (experimental) The time elapsed during an outage for failing/recovering jobs. |
MetricFullRestarts(IMetricOptions) | (experimental) The total number of times this job has fully restarted since it was submitted. |
MetricHeapMemoryUtilization(IMetricOptions) | (experimental) Overall heap memory utilization across task managers. |
MetricIdleTimeMsPerSecond(IMetricOptions) | (experimental) The time (in milliseconds) this task or operator is idle (has no data to process) per second. |
MetricKpus(IMetricOptions) | (experimental) The number of Kinesis Processing Units that are used to run your stream processing application. |
MetricLastCheckpointDuration(IMetricOptions) | (experimental) The time it took to complete the last checkpoint. |
MetricLastCheckpointSize(IMetricOptions) | (experimental) The total size of the last checkpoint. |
MetricManagedMemoryTotal(IMetricOptions) | (experimental) The total amount of managed memory. |
MetricManagedMemoryUsed(IMetricOptions) | (experimental) The amount of managed memory currently used. |
MetricManagedMemoryUtilization(IMetricOptions) | (experimental) Derived from managedMemoryUsed/managedMemoryTotal. |
MetricNumberOfFailedCheckpoints(IMetricOptions) | (experimental) The number of times checkpointing has failed. |
MetricNumLateRecordsDropped(IMetricOptions) | (experimental) The number of records this operator or task has dropped due to arriving late. |
MetricNumRecordsIn(IMetricOptions) | (experimental) The total number of records this application, operator, or task has received. |
MetricNumRecordsInPerSecond(IMetricOptions) | (experimental) The total number of records this application, operator or task has received per second. |
MetricNumRecordsOut(IMetricOptions) | (experimental) The total number of records this application, operator or task has emitted. |
MetricNumRecordsOutPerSecond(IMetricOptions) | (experimental) The total number of records this application, operator or task has emitted per second. |
MetricOldGenerationGCCount(IMetricOptions) | (experimental) The total number of old garbage collection operations that have occurred across all task managers. |
MetricOldGenerationGCTime(IMetricOptions) | (experimental) The total time spent performing old garbage collection operations. |
MetricThreadsCount(IMetricOptions) | (experimental) The total number of live threads used by the application. |
MetricUptime(IMetricOptions) | (experimental) The time that the job has been running without interruption. |
Constructors
Application(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Application(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Application(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Application(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Application(Construct, String, IApplicationProps)
public Application(Construct scope, string id, IApplicationProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IApplicationProps
Remarks
Stability: Experimental
Properties
ApplicationArn
(experimental) The application ARN.
public virtual string ApplicationArn { get; }
Property Value
System.String
Remarks
Stability: Experimental
ApplicationName
(experimental) The name of the Flink application.
public virtual string ApplicationName { get; }
Property Value
System.String
Remarks
Stability: Experimental
GrantPrincipal
(experimental) The principal to grant permissions to.
public virtual IPrincipal GrantPrincipal { get; }
Property Value
Remarks
Stability: Experimental
Role
(experimental) The application IAM role.
public virtual IRole Role { get; }
Property Value
Remarks
Stability: Experimental
Methods
AddToRolePolicy(PolicyStatement)
(experimental) Implement the convenience {@link IApplication.addToPrincipalPolicy} method.
public virtual bool AddToRolePolicy(PolicyStatement policyStatement)
Parameters
- policyStatement PolicyStatement
Returns
System.Boolean
Remarks
Stability: Experimental
FromApplicationArn(Construct, String, String)
(experimental) Import an existing application defined outside of CDK code by applicationArn.
public static IApplication FromApplicationArn(Construct scope, string id, string applicationArn)
Parameters
- scope Constructs.Construct
- id System.String
- applicationArn System.String
Returns
Remarks
Stability: Experimental
FromApplicationName(Construct, String, String)
(experimental) Import an existing Flink application defined outside of CDK code by applicationName.
public static IApplication FromApplicationName(Construct scope, string id, string applicationName)
Parameters
- scope Constructs.Construct
- id System.String
- applicationName System.String
Returns
Remarks
Stability: Experimental
Metric(String, IMetricOptions)
(experimental) Return a CloudWatch metric associated with this Flink application.
public virtual Metric Metric(string metricName, IMetricOptions props = null)
Parameters
- metricName System.String
The name of the metric.
- props IMetricOptions
Customization properties.
Returns
Remarks
Stability: Experimental
MetricBackPressuredTimeMsPerSecond(IMetricOptions)
(experimental) The time (in milliseconds) this task or operator is back pressured per second.
public virtual Metric MetricBackPressuredTimeMsPerSecond(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Milliseconds
Reporting Level: Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricBusyTimePerMsPerSecond(IMetricOptions)
(experimental) The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second.
public virtual Metric MetricBusyTimePerMsPerSecond(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Can be NaN, if the value could not be calculated.
Units: Milliseconds
Reporting Level: Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricCpuUtilization(IMetricOptions)
(experimental) The overall percentage of CPU utilization across task managers.
public virtual Metric MetricCpuUtilization(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
For example, if there are five task managers, Kinesis Data Analytics publishes five samples of this metric per reporting interval.
Units: Percentage
Reporting Level: Application
Default: average over 5 minutes
Stability: Experimental
MetricCurrentInputWatermark(IMetricOptions)
(experimental) The last watermark this application/operator/task/thread has received.
public virtual Metric MetricCurrentInputWatermark(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Milliseconds
Reporting Level: Application, Operator, Task, Parallelism
Default: maximum over 5 minutes
Stability: Experimental
MetricCurrentOutputWatermark(IMetricOptions)
(experimental) The last watermark this application/operator/task/thread has received.
public virtual Metric MetricCurrentOutputWatermark(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Milliseconds
Reporting Level: Application, Operator, Task, Parallelism
Default: maximum over 5 minutes
Stability: Experimental
MetricDowntime(IMetricOptions)
(experimental) The time elapsed during an outage for failing/recovering jobs.
public virtual Metric MetricDowntime(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Milliseconds
Reporting Level: Application
Default: average over 5 minutes
Stability: Experimental
MetricFullRestarts(IMetricOptions)
(experimental) The total number of times this job has fully restarted since it was submitted.
public virtual Metric MetricFullRestarts(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
This metric does not measure fine-grained restarts.
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
Stability: Experimental
MetricHeapMemoryUtilization(IMetricOptions)
(experimental) Overall heap memory utilization across task managers.
public virtual Metric MetricHeapMemoryUtilization(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
For example, if there are five task managers, Kinesis Data Analytics publishes five samples of this metric per reporting interval.
Units: Percentage
Reporting Level: Application
Default: average over 5 minutes
Stability: Experimental
MetricIdleTimeMsPerSecond(IMetricOptions)
(experimental) The time (in milliseconds) this task or operator is idle (has no data to process) per second.
public virtual Metric MetricIdleTimeMsPerSecond(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Idle time excludes back pressured time, so if the task is back pressured it is not idle.
Units: Milliseconds
Reporting Level: Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricKpus(IMetricOptions)
(experimental) The number of Kinesis Processing Units that are used to run your stream processing application.
public virtual Metric MetricKpus(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
The average number of KPUs used each hour determines the billing for your application.
Units: Count
Reporting Level: Application
Default: average over 5 minutes
Stability: Experimental
MetricLastCheckpointDuration(IMetricOptions)
(experimental) The time it took to complete the last checkpoint.
public virtual Metric MetricLastCheckpointDuration(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Milliseconds
Reporting Level: Application
Default: maximum over 5 minutes
Stability: Experimental
MetricLastCheckpointSize(IMetricOptions)
(experimental) The total size of the last checkpoint.
public virtual Metric MetricLastCheckpointSize(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Bytes
Reporting Level: Application
Default: maximum over 5 minutes
Stability: Experimental
MetricManagedMemoryTotal(IMetricOptions)
(experimental) The total amount of managed memory.
public virtual Metric MetricManagedMemoryTotal(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Bytes
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricManagedMemoryUsed(IMetricOptions)
(experimental) The amount of managed memory currently used.
public virtual Metric MetricManagedMemoryUsed(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Bytes
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricManagedMemoryUtilization(IMetricOptions)
(experimental) Derived from managedMemoryUsed/managedMemoryTotal.
public virtual Metric MetricManagedMemoryUtilization(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Percentage
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricNumberOfFailedCheckpoints(IMetricOptions)
(experimental) The number of times checkpointing has failed.
public virtual Metric MetricNumberOfFailedCheckpoints(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
Stability: Experimental
MetricNumLateRecordsDropped(IMetricOptions)
(experimental) The number of records this operator or task has dropped due to arriving late.
public virtual Metric MetricNumLateRecordsDropped(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: sum over 5 minutes
Stability: Experimental
MetricNumRecordsIn(IMetricOptions)
(experimental) The total number of records this application, operator, or task has received.
public virtual Metric MetricNumRecordsIn(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricNumRecordsInPerSecond(IMetricOptions)
(experimental) The total number of records this application, operator or task has received per second.
public virtual Metric MetricNumRecordsInPerSecond(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count/Second
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricNumRecordsOut(IMetricOptions)
(experimental) The total number of records this application, operator or task has emitted.
public virtual Metric MetricNumRecordsOut(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricNumRecordsOutPerSecond(IMetricOptions)
(experimental) The total number of records this application, operator or task has emitted per second.
public virtual Metric MetricNumRecordsOutPerSecond(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count/Second
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
Stability: Experimental
MetricOldGenerationGCCount(IMetricOptions)
(experimental) The total number of old garbage collection operations that have occurred across all task managers.
public virtual Metric MetricOldGenerationGCCount(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
Stability: Experimental
MetricOldGenerationGCTime(IMetricOptions)
(experimental) The total time spent performing old garbage collection operations.
public virtual Metric MetricOldGenerationGCTime(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Milliseconds
Reporting Level: Application
Default: sum over 5 minutes
Stability: Experimental
MetricThreadsCount(IMetricOptions)
(experimental) The total number of live threads used by the application.
public virtual Metric MetricThreadsCount(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Count
Reporting Level: Application
Default: average over 5 minutes
Stability: Experimental
MetricUptime(IMetricOptions)
(experimental) The time that the job has been running without interruption.
public virtual Metric MetricUptime(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Units: Milliseconds
Reporting Level: Application
Default: average over 5 minutes
Stability: Experimental