Package software.amazon.awscdk.services.kinesisanalytics.flink.alpha

Interface IApplication.Jsii$Default

All Superinterfaces:
IApplication, IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IApplication.Jsii$Proxy
Enclosing interface:
IApplication
@Internal public static interface IApplication.Jsii$Default extends IApplication, IResource.Jsii$Default, IConnectable.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IApplication.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getConnections

      @Stability(Stable) @NotNull default Connections getConnections()
      The network connections associated with this resource.
      Specified by:
      getConnections in interface IConnectable
      Specified by:
      getConnections in interface IConnectable.Jsii$Default

    • getGrantPrincipal

      @Stability(Stable) @NotNull default IPrincipal getGrantPrincipal()
      The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable
      Specified by:
      getGrantPrincipal in interface IGrantable.Jsii$Default

    • getApplicationArn

      @Stability(Experimental) @NotNull default String getApplicationArn()
      (experimental) The application ARN.
      Specified by:
      getApplicationArn in interface IApplication

    • getApplicationName

      @Stability(Experimental) @NotNull default String getApplicationName()
      (experimental) The name of the Flink application.
      Specified by:
      getApplicationName in interface IApplication

    • getRole

      @Stability(Experimental) @Nullable default IRole getRole()
      (experimental) The application IAM role.
      Specified by:
      getRole in interface IApplication

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addToRolePolicy

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

      Specified by:
      addToRolePolicy in interface IApplication
      Parameters:
      policyStatement - This parameter is required.

    • metric

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

      Specified by:
      metric in interface IApplication
      Parameters:
      metricName - The name of the metric. This parameter is required.
      props - Customization properties.

    • metricBackPressuredTimeMsPerSecond

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricBackPressuredTimeMsPerSecond in interface IApplication
      Parameters:
      props -

    • metricBusyTimePerMsPerSecond

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricBusyTimePerMsPerSecond in interface IApplication
      Parameters:
      props -

    • metricCpuUtilization

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricCpuUtilization in interface IApplication
      Parameters:
      props -

    • metricCurrentInputWatermark

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricCurrentInputWatermark in interface IApplication
      Parameters:
      props -

    • metricCurrentOutputWatermark

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricCurrentOutputWatermark in interface IApplication
      Parameters:
      props -

    • metricDowntime

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricDowntime in interface IApplication
      Parameters:
      props -

    • metricFullRestarts

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricFullRestarts in interface IApplication
      Parameters:
      props -

    • metricHeapMemoryUtilization

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricHeapMemoryUtilization in interface IApplication
      Parameters:
      props -

    • metricIdleTimeMsPerSecond

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricIdleTimeMsPerSecond in interface IApplication
      Parameters:
      props -

    • metricKpus

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricKpus in interface IApplication
      Parameters:
      props -

    • metricLastCheckpointDuration

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricLastCheckpointDuration in interface IApplication
      Parameters:
      props -

    • metricLastCheckpointSize

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

      Units: Bytes

      Reporting Level: Application

      Default: - maximum over 5 minutes

      Specified by:
      metricLastCheckpointSize in interface IApplication
      Parameters:
      props -

    • metricManagedMemoryTotal

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricManagedMemoryTotal in interface IApplication
      Parameters:
      props -

    • metricManagedMemoryUsed

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricManagedMemoryUsed in interface IApplication
      Parameters:
      props -

    • metricManagedMemoryUtilization

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

      Units: Percentage

      Reporting Level: Application, Operator, Task, Parallelism

      Default: - average over 5 minutes

      Specified by:
      metricManagedMemoryUtilization in interface IApplication
      Parameters:
      props -

    • metricNumberOfFailedCheckpoints

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

      Units: Count

      Reporting Level: Application

      Default: - sum over 5 minutes

      Specified by:
      metricNumberOfFailedCheckpoints in interface IApplication
      Parameters:
      props -

    • metricNumLateRecordsDropped

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricNumLateRecordsDropped in interface IApplication
      Parameters:
      props -

    • metricNumRecordsIn

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricNumRecordsIn in interface IApplication
      Parameters:
      props -

    • metricNumRecordsInPerSecond

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricNumRecordsInPerSecond in interface IApplication
      Parameters:
      props -

    • metricNumRecordsOut

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricNumRecordsOut in interface IApplication
      Parameters:
      props -

    • metricNumRecordsOutPerSecond

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricNumRecordsOutPerSecond in interface IApplication
      Parameters:
      props -

    • metricOldGenerationGCCount

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricOldGenerationGCCount in interface IApplication
      Parameters:
      props -

    • metricOldGenerationGCTime

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricOldGenerationGCTime in interface IApplication
      Parameters:
      props -

    • metricThreadsCount

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricThreadsCount in interface IApplication
      Parameters:
      props -

    • metricUptime

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricUptime in interface IApplication
      Parameters:
      props -