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

Interface IApplication

All Superinterfaces:
IConstruct, software.constructs.IConstruct, IDependable, IGrantable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IApplication.Jsii$Default
All Known Implementing Classes:
Application, IApplication.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.666Z") @Stability(Experimental) public interface IApplication extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable
(experimental) An interface expressing the public properties on both an imported and CDK-created Flink application.

  • Method Details

    • getApplicationArn

      @Stability(Experimental) @NotNull String getApplicationArn()
      (experimental) The application ARN.

    • getApplicationName

      @Stability(Experimental) @NotNull String getApplicationName()
      (experimental) The name of the Flink application.

    • getRole

      @Stability(Experimental) @Nullable default IRole getRole()
      (experimental) The application IAM role.

    • addToRolePolicy

      @Stability(Experimental) @NotNull Boolean addToRolePolicy(@NotNull PolicyStatement policyStatement)
      (experimental) Convenience method for adding a policy statement to the application role.

      Parameters:
      policyStatement - This parameter is required.

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Return a CloudWatch metric associated with this Flink application.

      Parameters:
      metricName - The name of the metric. This parameter is required.
      props - Customization properties.

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName)
      (experimental) Return a CloudWatch metric associated with this Flink application.

      Parameters:
      metricName - The name of the metric. This parameter is required.

    • metricBackPressuredTimeMsPerSecond

      @Stability(Experimental) @NotNull Metric metricBackPressuredTimeMsPerSecond(@Nullable MetricOptions props)
      (experimental) The time (in milliseconds) this task or operator is back pressured per second.

      Units: Milliseconds

      Reporting Level: Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricBackPressuredTimeMsPerSecond

      @Stability(Experimental) @NotNull Metric metricBackPressuredTimeMsPerSecond()
      (experimental) The time (in milliseconds) this task or operator is back pressured per second.

      Units: Milliseconds

      Reporting Level: Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricBusyTimePerMsPerSecond

      @Stability(Experimental) @NotNull Metric metricBusyTimePerMsPerSecond(@Nullable MetricOptions props)
      (experimental) The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second.

      Can be NaN, if the value could not be calculated.

      Units: Milliseconds

      Reporting Level: Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricBusyTimePerMsPerSecond

      @Stability(Experimental) @NotNull Metric metricBusyTimePerMsPerSecond()
      (experimental) The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second.

      Can be NaN, if the value could not be calculated.

      Units: Milliseconds

      Reporting Level: Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricCpuUtilization

      @Stability(Experimental) @NotNull Metric metricCpuUtilization(@Nullable MetricOptions props)
      (experimental) The overall percentage of CPU utilization across task managers.

      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

      Parameters:
      props -

    • metricCpuUtilization

      @Stability(Experimental) @NotNull Metric metricCpuUtilization()
      (experimental) The overall percentage of CPU utilization across task managers.

      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

    • metricCurrentInputWatermark

      @Stability(Experimental) @NotNull Metric metricCurrentInputWatermark(@Nullable MetricOptions props)
      (experimental) The last watermark this application/operator/task/thread has received.

      Units: Milliseconds

      Reporting Level: Application, Operator, Task, Parallelism

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricCurrentInputWatermark

      @Stability(Experimental) @NotNull Metric metricCurrentInputWatermark()
      (experimental) The last watermark this application/operator/task/thread has received.

      Units: Milliseconds

      Reporting Level: Application, Operator, Task, Parallelism

      Default: maximum over 5 minutes

    • metricCurrentOutputWatermark

      @Stability(Experimental) @NotNull Metric metricCurrentOutputWatermark(@Nullable MetricOptions props)
      (experimental) The last watermark this application/operator/task/thread has received.

      Units: Milliseconds

      Reporting Level: Application, Operator, Task, Parallelism

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricCurrentOutputWatermark

      @Stability(Experimental) @NotNull Metric metricCurrentOutputWatermark()
      (experimental) The last watermark this application/operator/task/thread has received.

      Units: Milliseconds

      Reporting Level: Application, Operator, Task, Parallelism

      Default: maximum over 5 minutes

    • metricDowntime

      @Stability(Experimental) @NotNull Metric metricDowntime(@Nullable MetricOptions props)
      (experimental) The time elapsed during an outage for failing/recovering jobs.

      Units: Milliseconds

      Reporting Level: Application

      Default: average over 5 minutes

      Parameters:
      props -

    • metricDowntime

      @Stability(Experimental) @NotNull Metric metricDowntime()
      (experimental) The time elapsed during an outage for failing/recovering jobs.

      Units: Milliseconds

      Reporting Level: Application

      Default: average over 5 minutes

    • metricFullRestarts

      @Stability(Experimental) @NotNull Metric metricFullRestarts(@Nullable MetricOptions props)
      (experimental) The total number of times this job has fully restarted since it was submitted.

      This metric does not measure fine-grained restarts.

      Units: Count

      Reporting Level: Application

      Default: sum over 5 minutes

      Parameters:
      props -

    • metricFullRestarts

      @Stability(Experimental) @NotNull Metric metricFullRestarts()
      (experimental) The total number of times this job has fully restarted since it was submitted.

      This metric does not measure fine-grained restarts.

      Units: Count

      Reporting Level: Application

      Default: sum over 5 minutes

    • metricHeapMemoryUtilization

      @Stability(Experimental) @NotNull Metric metricHeapMemoryUtilization(@Nullable MetricOptions props)
      (experimental) Overall heap memory utilization across task managers.

      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

      Parameters:
      props -

    • metricHeapMemoryUtilization

      @Stability(Experimental) @NotNull Metric metricHeapMemoryUtilization()
      (experimental) Overall heap memory utilization across task managers.

      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

    • metricIdleTimeMsPerSecond

      @Stability(Experimental) @NotNull Metric metricIdleTimeMsPerSecond(@Nullable MetricOptions props)
      (experimental) The time (in milliseconds) this task or operator is idle (has no data to process) per second.

      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

      Parameters:
      props -

    • metricIdleTimeMsPerSecond

      @Stability(Experimental) @NotNull Metric metricIdleTimeMsPerSecond()
      (experimental) The time (in milliseconds) this task or operator is idle (has no data to process) per second.

      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

    • metricKpus

      @Stability(Experimental) @NotNull Metric metricKpus(@Nullable MetricOptions props)
      (experimental) The number of Kinesis Processing Units that are used to run your stream processing application.

      The average number of KPUs used each hour determines the billing for your application.

      Units: Count

      Reporting Level: Application

      Default: average over 5 minutes

      Parameters:
      props -

    • metricKpus

      @Stability(Experimental) @NotNull Metric metricKpus()
      (experimental) The number of Kinesis Processing Units that are used to run your stream processing application.

      The average number of KPUs used each hour determines the billing for your application.

      Units: Count

      Reporting Level: Application

      Default: average over 5 minutes

    • metricLastCheckpointDuration

      @Stability(Experimental) @NotNull Metric metricLastCheckpointDuration(@Nullable MetricOptions props)
      (experimental) The time it took to complete the last checkpoint.

      Units: Milliseconds

      Reporting Level: Application

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricLastCheckpointDuration

      @Stability(Experimental) @NotNull Metric metricLastCheckpointDuration()
      (experimental) The time it took to complete the last checkpoint.

      Units: Milliseconds

      Reporting Level: Application

      Default: maximum over 5 minutes

    • metricLastCheckpointSize

      @Stability(Experimental) @NotNull Metric metricLastCheckpointSize(@Nullable MetricOptions props)
      (experimental) The total size of the last checkpoint.

      Units: Bytes

      Reporting Level: Application

      Default: maximum over 5 minutes

      Parameters:
      props -

    • metricLastCheckpointSize

      @Stability(Experimental) @NotNull Metric metricLastCheckpointSize()
      (experimental) The total size of the last checkpoint.

      Units: Bytes

      Reporting Level: Application

      Default: maximum over 5 minutes

    • metricManagedMemoryTotal

      @Stability(Experimental) @NotNull Metric metricManagedMemoryTotal(@Nullable MetricOptions props)
      (experimental) The total amount of managed memory.

      Units: Bytes

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricManagedMemoryTotal

      @Stability(Experimental) @NotNull Metric metricManagedMemoryTotal()
      (experimental) The total amount of managed memory.

      Units: Bytes

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricManagedMemoryUsed

      @Stability(Experimental) @NotNull Metric metricManagedMemoryUsed(@Nullable MetricOptions props)
      (experimental) The amount of managed memory currently used.

      Units: Bytes

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricManagedMemoryUsed

      @Stability(Experimental) @NotNull Metric metricManagedMemoryUsed()
      (experimental) The amount of managed memory currently used.

      Units: Bytes

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricManagedMemoryUtilization

      @Stability(Experimental) @NotNull Metric metricManagedMemoryUtilization(@Nullable MetricOptions props)
      (experimental) Derived from managedMemoryUsed/managedMemoryTotal.

      Units: Percentage

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricManagedMemoryUtilization

      @Stability(Experimental) @NotNull Metric metricManagedMemoryUtilization()
      (experimental) Derived from managedMemoryUsed/managedMemoryTotal.

      Units: Percentage

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricNumberOfFailedCheckpoints

      @Stability(Experimental) @NotNull Metric metricNumberOfFailedCheckpoints(@Nullable MetricOptions props)
      (experimental) The number of times checkpointing has failed.

      Units: Count

      Reporting Level: Application

      Default: sum over 5 minutes

      Parameters:
      props -

    • metricNumberOfFailedCheckpoints

      @Stability(Experimental) @NotNull Metric metricNumberOfFailedCheckpoints()
      (experimental) The number of times checkpointing has failed.

      Units: Count

      Reporting Level: Application

      Default: sum over 5 minutes

    • metricNumLateRecordsDropped

      @Stability(Experimental) @NotNull Metric metricNumLateRecordsDropped(@Nullable MetricOptions props)
      (experimental) The number of records this operator or task has dropped due to arriving late.

      Units: Count

      Reporting Level: Application, Operator, Task, Parallelism

      Default: sum over 5 minutes

      Parameters:
      props -

    • metricNumLateRecordsDropped

      @Stability(Experimental) @NotNull Metric metricNumLateRecordsDropped()
      (experimental) The number of records this operator or task has dropped due to arriving late.

      Units: Count

      Reporting Level: Application, Operator, Task, Parallelism

      Default: sum over 5 minutes

    • metricNumRecordsIn

      @Stability(Experimental) @NotNull Metric metricNumRecordsIn(@Nullable MetricOptions props)
      (experimental) The total number of records this application, operator, or task has received.

      Units: Count

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricNumRecordsIn

      @Stability(Experimental) @NotNull Metric metricNumRecordsIn()
      (experimental) The total number of records this application, operator, or task has received.

      Units: Count

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricNumRecordsInPerSecond

      @Stability(Experimental) @NotNull Metric metricNumRecordsInPerSecond(@Nullable MetricOptions props)
      (experimental) The total number of records this application, operator or task has received per second.

      Units: Count/Second

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricNumRecordsInPerSecond

      @Stability(Experimental) @NotNull Metric metricNumRecordsInPerSecond()
      (experimental) The total number of records this application, operator or task has received per second.

      Units: Count/Second

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricNumRecordsOut

      @Stability(Experimental) @NotNull Metric metricNumRecordsOut(@Nullable MetricOptions props)
      (experimental) The total number of records this application, operator or task has emitted.

      Units: Count

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricNumRecordsOut

      @Stability(Experimental) @NotNull Metric metricNumRecordsOut()
      (experimental) The total number of records this application, operator or task has emitted.

      Units: Count

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricNumRecordsOutPerSecond

      @Stability(Experimental) @NotNull Metric metricNumRecordsOutPerSecond(@Nullable MetricOptions props)
      (experimental) The total number of records this application, operator or task has emitted per second.

      Units: Count/Second

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

      Parameters:
      props -

    • metricNumRecordsOutPerSecond

      @Stability(Experimental) @NotNull Metric metricNumRecordsOutPerSecond()
      (experimental) The total number of records this application, operator or task has emitted per second.

      Units: Count/Second

      Reporting Level: Application, Operator, Task, Parallelism

      Default: average over 5 minutes

    • metricOldGenerationGCCount

      @Stability(Experimental) @NotNull Metric metricOldGenerationGCCount(@Nullable MetricOptions props)
      (experimental) The total number of old garbage collection operations that have occurred across all task managers.

      Units: Count

      Reporting Level: Application

      Default: sum over 5 minutes

      Parameters:
      props -

    • metricOldGenerationGCCount

      @Stability(Experimental) @NotNull Metric metricOldGenerationGCCount()
      (experimental) The total number of old garbage collection operations that have occurred across all task managers.

      Units: Count

      Reporting Level: Application

      Default: sum over 5 minutes

    • metricOldGenerationGCTime

      @Stability(Experimental) @NotNull Metric metricOldGenerationGCTime(@Nullable MetricOptions props)
      (experimental) The total time spent performing old garbage collection operations.

      Units: Milliseconds

      Reporting Level: Application

      Default: sum over 5 minutes

      Parameters:
      props -

    • metricOldGenerationGCTime

      @Stability(Experimental) @NotNull Metric metricOldGenerationGCTime()
      (experimental) The total time spent performing old garbage collection operations.

      Units: Milliseconds

      Reporting Level: Application

      Default: sum over 5 minutes

    • metricThreadsCount

      @Stability(Experimental) @NotNull Metric metricThreadsCount(@Nullable MetricOptions props)
      (experimental) The total number of live threads used by the application.

      Units: Count

      Reporting Level: Application

      Default: average over 5 minutes

      Parameters:
      props -

    • metricThreadsCount

      @Stability(Experimental) @NotNull Metric metricThreadsCount()
      (experimental) The total number of live threads used by the application.

      Units: Count

      Reporting Level: Application

      Default: average over 5 minutes

    • metricUptime

      @Stability(Experimental) @NotNull Metric metricUptime(@Nullable MetricOptions props)
      (experimental) The time that the job has been running without interruption.

      Units: Milliseconds

      Reporting Level: Application

      Default: sample count over 5 minutes

      Parameters:
      props -

    • metricUptime

      @Stability(Experimental) @NotNull Metric metricUptime()
      (experimental) The time that the job has been running without interruption.

      Units: Milliseconds

      Reporting Level: Application

      Default: sample count over 5 minutes