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

Interface IApplication.Jsii$Default

All Superinterfaces:

IApplication, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, 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, IGrantable.Jsii$Default

Internal default implementation for IApplication.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesis.analytics.flink.IApplication

IApplication.Jsii$Default, IApplication.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default Boolean	addToRolePolicy(PolicyStatement policyStatement) (experimental) Convenience method for adding a policy statement to the application role.
default void	applyRemovalPolicy(RemovalPolicy policy) (experimental) Apply the given removal policy to this resource.
default String	getApplicationArn() (experimental) The application ARN.
default String	getApplicationName() (experimental) The name of the Flink application.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
default ConstructNode	getNode() (experimental) The construct tree node for this construct.
default IRole	getRole() (experimental) The application IAM role.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default Metric	metric(String metricName, MetricOptions props) (experimental) Return a CloudWatch metric associated with this Flink application.
default Metric	metricBackPressuredTimeMsPerSecond(MetricOptions props) (experimental) The time (in milliseconds) this task or operator is back pressured per second.
default Metric	metricBusyTimePerMsPerSecond(MetricOptions props) (experimental) The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second.
default Metric	metricCpuUtilization(MetricOptions props) (experimental) The overall percentage of CPU utilization across task managers.
default Metric	metricCurrentInputWatermark(MetricOptions props) (experimental) The last watermark this application/operator/task/thread has received.
default Metric	metricCurrentOutputWatermark(MetricOptions props) (experimental) The last watermark this application/operator/task/thread has received.
default Metric	metricDowntime(MetricOptions props) (experimental) The time elapsed during an outage for failing/recovering jobs.
default Metric	metricFullRestarts(MetricOptions props) (experimental) The total number of times this job has fully restarted since it was submitted.
default Metric	metricHeapMemoryUtilization(MetricOptions props) (experimental) Overall heap memory utilization across task managers.
default Metric	metricIdleTimeMsPerSecond(MetricOptions props) (experimental) The time (in milliseconds) this task or operator is idle (has no data to process) per second.
default Metric	metricKpus(MetricOptions props) (experimental) The number of Kinesis Processing Units that are used to run your stream processing application.
default Metric	metricLastCheckpointDuration(MetricOptions props) (experimental) The time it took to complete the last checkpoint.
default Metric	metricLastCheckpointSize(MetricOptions props) (experimental) The total size of the last checkpoint.
default Metric	metricManagedMemoryTotal(MetricOptions props) (experimental) The total amount of managed memory.
default Metric	metricManagedMemoryUsed(MetricOptions props) (experimental) The amount of managed memory currently used.
default Metric	metricManagedMemoryUtilization(MetricOptions props) (experimental) Derived from managedMemoryUsed/managedMemoryTotal.
default Metric	metricNumberOfFailedCheckpoints(MetricOptions props) (experimental) The number of times checkpointing has failed.
default Metric	metricNumLateRecordsDropped(MetricOptions props) (experimental) The number of records this operator or task has dropped due to arriving late.
default Metric	metricNumRecordsIn(MetricOptions props) (experimental) The total number of records this application, operator, or task has received.
default Metric	metricNumRecordsInPerSecond(MetricOptions props) (experimental) The total number of records this application, operator or task has received per second.
default Metric	metricNumRecordsOut(MetricOptions props) (experimental) The total number of records this application, operator or task has emitted.
default Metric	metricNumRecordsOutPerSecond(MetricOptions props) (experimental) The total number of records this application, operator or task has emitted per second.
default Metric	metricOldGenerationGCCount(MetricOptions props) (experimental) The total number of old garbage collection operations that have occurred across all task managers.
default Metric	metricOldGenerationGCTime(MetricOptions props) (experimental) The total time spent performing old garbage collection operations.
default Metric	metricThreadsCount(MetricOptions props) (experimental) The total number of live threads used by the application.
default Metric	metricUptime(MetricOptions props) (experimental) The time that the job has been running without interruption.

Methods inherited from interface software.amazon.awscdk.services.kinesis.analytics.flink.IApplication

metric, metricBackPressuredTimeMsPerSecond, metricBusyTimePerMsPerSecond, metricCpuUtilization, metricCurrentInputWatermark, metricCurrentOutputWatermark, metricDowntime, metricFullRestarts, metricHeapMemoryUtilization, metricIdleTimeMsPerSecond, metricKpus, metricLastCheckpointDuration, metricLastCheckpointSize, metricManagedMemoryTotal, metricManagedMemoryUsed, metricManagedMemoryUtilization, metricNumberOfFailedCheckpoints, metricNumLateRecordsDropped, metricNumRecordsIn, metricNumRecordsInPerSecond, metricNumRecordsOut, metricNumRecordsOutPerSecond, metricOldGenerationGCCount, metricOldGenerationGCTime, metricThreadsCount, metricUptime

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Experimental)
 @NotNull
default ConstructNode getNode()

(experimental) The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) 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(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
default IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getApplicationArn

@Stability(value=Experimental)
 @NotNull
default String getApplicationArn()

(experimental) The application ARN.

Specified by:

getApplicationArn in interface IApplication

getApplicationName

@Stability(value=Experimental)
 @NotNull
default String getApplicationName()

(experimental) The name of the Flink application.

Specified by:

getApplicationName in interface IApplication

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) The application IAM role.

Specified by:

getRole in interface IApplication

applyRemovalPolicy

@Stability(value=Experimental)
default void applyRemovalPolicy(@NotNull
                                                               RemovalPolicy policy)

(experimental) 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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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 -