@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-19T23:09:26.557Z") @Stability(value=Experimental) public class Application extends Resource implements IApplication
Example:
import path.*; import software.amazon.awscdk.core.*; import software.amazon.awscdk.services.kinesis.analytics.flink.*; import software.amazon.awscdk.services.cloudwatch.*; App app = new App(); Stack stack = new Stack(app, "FlinkAppTest"); Application flinkApp = Application.Builder.create(stack, "App") .code(ApplicationCode.fromAsset(join(__dirname, "code-asset"))) .runtime(Runtime.FLINK_1_11) .build(); Alarm.Builder.create(stack, "Alarm") .metric(flinkApp.metricFullRestarts()) .evaluationPeriods(1) .threshold(3) .build(); app.synth();
Modifier and Type | Class and Description |
---|---|
static class |
Application.Builder
(experimental) A fluent builder for
Application . |
software.amazon.jsii.JsiiObject.InitializationMode
IApplication.Jsii$Default, IApplication.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
|
Application(software.constructs.Construct scope,
String id,
ApplicationProps props) |
protected |
Application(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Application(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
Boolean |
addToRolePolicy(PolicyStatement policyStatement)
(experimental) Implement the convenience
IApplication.addToPrincipalPolicy method. |
static IApplication |
fromApplicationArn(software.constructs.Construct scope,
String id,
String applicationArn)
(experimental) Import an existing application defined outside of CDK code by applicationArn.
|
static IApplication |
fromApplicationName(software.constructs.Construct scope,
String id,
String applicationName)
(experimental) Import an existing Flink application defined outside of CDK code by applicationName.
|
String |
getApplicationArn()
(experimental) The application ARN.
|
String |
getApplicationName()
(experimental) The name of the Flink application.
|
IPrincipal |
getGrantPrincipal()
(experimental) The principal to grant permissions to.
|
IRole |
getRole()
(experimental) The application IAM role.
|
Metric |
metric(String metricName)
(experimental) Return a CloudWatch metric associated with this Flink application.
|
Metric |
metric(String metricName,
MetricOptions props)
(experimental) Return a CloudWatch metric associated with this Flink application.
|
Metric |
metricBackPressuredTimeMsPerSecond()
(experimental) The time (in milliseconds) this task or operator is back pressured per second.
|
Metric |
metricBackPressuredTimeMsPerSecond(MetricOptions props)
(experimental) The time (in milliseconds) this task or operator is back pressured per second.
|
Metric |
metricBusyTimePerMsPerSecond()
(experimental) The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second.
|
Metric |
metricBusyTimePerMsPerSecond(MetricOptions props)
(experimental) The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second.
|
Metric |
metricCpuUtilization()
(experimental) The overall percentage of CPU utilization across task managers.
|
Metric |
metricCpuUtilization(MetricOptions props)
(experimental) The overall percentage of CPU utilization across task managers.
|
Metric |
metricCurrentInputWatermark()
(experimental) The last watermark this application/operator/task/thread has received.
|
Metric |
metricCurrentInputWatermark(MetricOptions props)
(experimental) The last watermark this application/operator/task/thread has received.
|
Metric |
metricCurrentOutputWatermark()
(experimental) The last watermark this application/operator/task/thread has received.
|
Metric |
metricCurrentOutputWatermark(MetricOptions props)
(experimental) The last watermark this application/operator/task/thread has received.
|
Metric |
metricDowntime()
(experimental) The time elapsed during an outage for failing/recovering jobs.
|
Metric |
metricDowntime(MetricOptions props)
(experimental) The time elapsed during an outage for failing/recovering jobs.
|
Metric |
metricFullRestarts()
(experimental) The total number of times this job has fully restarted since it was submitted.
|
Metric |
metricFullRestarts(MetricOptions props)
(experimental) The total number of times this job has fully restarted since it was submitted.
|
Metric |
metricHeapMemoryUtilization()
(experimental) Overall heap memory utilization across task managers.
|
Metric |
metricHeapMemoryUtilization(MetricOptions props)
(experimental) Overall heap memory utilization across task managers.
|
Metric |
metricIdleTimeMsPerSecond()
(experimental) The time (in milliseconds) this task or operator is idle (has no data to process) per second.
|
Metric |
metricIdleTimeMsPerSecond(MetricOptions props)
(experimental) The time (in milliseconds) this task or operator is idle (has no data to process) per second.
|
Metric |
metricKpus()
(experimental) The number of Kinesis Processing Units that are used to run your stream processing application.
|
Metric |
metricKpus(MetricOptions props)
(experimental) The number of Kinesis Processing Units that are used to run your stream processing application.
|
Metric |
metricLastCheckpointDuration()
(experimental) The time it took to complete the last checkpoint.
|
Metric |
metricLastCheckpointDuration(MetricOptions props)
(experimental) The time it took to complete the last checkpoint.
|
Metric |
metricLastCheckpointSize()
(experimental) The total size of the last checkpoint.
|
Metric |
metricLastCheckpointSize(MetricOptions props)
(experimental) The total size of the last checkpoint.
|
Metric |
metricManagedMemoryTotal()
(experimental) The total amount of managed memory.
|
Metric |
metricManagedMemoryTotal(MetricOptions props)
(experimental) The total amount of managed memory.
|
Metric |
metricManagedMemoryUsed()
(experimental) The amount of managed memory currently used.
|
Metric |
metricManagedMemoryUsed(MetricOptions props)
(experimental) The amount of managed memory currently used.
|
Metric |
metricManagedMemoryUtilization()
(experimental) Derived from managedMemoryUsed/managedMemoryTotal.
|
Metric |
metricManagedMemoryUtilization(MetricOptions props)
(experimental) Derived from managedMemoryUsed/managedMemoryTotal.
|
Metric |
metricNumberOfFailedCheckpoints()
(experimental) The number of times checkpointing has failed.
|
Metric |
metricNumberOfFailedCheckpoints(MetricOptions props)
(experimental) The number of times checkpointing has failed.
|
Metric |
metricNumLateRecordsDropped()
(experimental) The number of records this operator or task has dropped due to arriving late.
|
Metric |
metricNumLateRecordsDropped(MetricOptions props)
(experimental) The number of records this operator or task has dropped due to arriving late.
|
Metric |
metricNumRecordsIn()
(experimental) The total number of records this application, operator, or task has received.
|
Metric |
metricNumRecordsIn(MetricOptions props)
(experimental) The total number of records this application, operator, or task has received.
|
Metric |
metricNumRecordsInPerSecond()
(experimental) The total number of records this application, operator or task has received per second.
|
Metric |
metricNumRecordsInPerSecond(MetricOptions props)
(experimental) The total number of records this application, operator or task has received per second.
|
Metric |
metricNumRecordsOut()
(experimental) The total number of records this application, operator or task has emitted.
|
Metric |
metricNumRecordsOut(MetricOptions props)
(experimental) The total number of records this application, operator or task has emitted.
|
Metric |
metricNumRecordsOutPerSecond()
(experimental) The total number of records this application, operator or task has emitted per second.
|
Metric |
metricNumRecordsOutPerSecond(MetricOptions props)
(experimental) The total number of records this application, operator or task has emitted per second.
|
Metric |
metricOldGenerationGCCount()
(experimental) The total number of old garbage collection operations that have occurred across all task managers.
|
Metric |
metricOldGenerationGCCount(MetricOptions props)
(experimental) The total number of old garbage collection operations that have occurred across all task managers.
|
Metric |
metricOldGenerationGCTime()
(experimental) The total time spent performing old garbage collection operations.
|
Metric |
metricOldGenerationGCTime(MetricOptions props)
(experimental) The total time spent performing old garbage collection operations.
|
Metric |
metricThreadsCount()
(experimental) The total number of live threads used by the application.
|
Metric |
metricThreadsCount(MetricOptions props)
(experimental) The total number of live threads used by the application.
|
Metric |
metricUptime()
(experimental) The time that the job has been running without interruption.
|
Metric |
metricUptime(MetricOptions props)
(experimental) The time that the job has been running without interruption.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected Application(software.amazon.jsii.JsiiObjectRef objRef)
protected Application(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Experimental) public Application(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ApplicationProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.@Stability(value=Experimental) @NotNull public static IApplication fromApplicationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String applicationArn)
scope
- This parameter is required.id
- This parameter is required.applicationArn
- This parameter is required.@Stability(value=Experimental) @NotNull public static IApplication fromApplicationName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String applicationName)
scope
- This parameter is required.id
- This parameter is required.applicationName
- This parameter is required.@Stability(value=Experimental) @NotNull public Boolean addToRolePolicy(@NotNull PolicyStatement policyStatement)
IApplication.addToPrincipalPolicy
method.
addToRolePolicy
in interface IApplication
policyStatement
- This parameter is required.@Stability(value=Experimental) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
metric
in interface IApplication
metricName
- The name of the metric. This parameter is required.props
- Customization properties.@Stability(value=Experimental) @NotNull public Metric metric(@NotNull String metricName)
metric
in interface IApplication
metricName
- The name of the metric. This parameter is required.@Stability(value=Experimental) @NotNull public Metric metricBackPressuredTimeMsPerSecond(@Nullable MetricOptions props)
Units: Milliseconds
Reporting Level: Operator, Task, Parallelism
Default: average over 5 minutes
metricBackPressuredTimeMsPerSecond
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricBackPressuredTimeMsPerSecond()
Units: Milliseconds
Reporting Level: Operator, Task, Parallelism
Default: average over 5 minutes
metricBackPressuredTimeMsPerSecond
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricBusyTimePerMsPerSecond(@Nullable MetricOptions props)
Can be NaN, if the value could not be calculated.
Units: Milliseconds
Reporting Level: Operator, Task, Parallelism
Default: average over 5 minutes
metricBusyTimePerMsPerSecond
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricBusyTimePerMsPerSecond()
Can be NaN, if the value could not be calculated.
Units: Milliseconds
Reporting Level: Operator, Task, Parallelism
Default: average over 5 minutes
metricBusyTimePerMsPerSecond
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricCpuUtilization(@Nullable MetricOptions props)
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
metricCpuUtilization
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricCpuUtilization()
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
metricCpuUtilization
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricCurrentInputWatermark(@Nullable MetricOptions props)
Units: Milliseconds
Reporting Level: Application, Operator, Task, Parallelism
Default: maximum over 5 minutes
metricCurrentInputWatermark
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricCurrentInputWatermark()
Units: Milliseconds
Reporting Level: Application, Operator, Task, Parallelism
Default: maximum over 5 minutes
metricCurrentInputWatermark
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricCurrentOutputWatermark(@Nullable MetricOptions props)
Units: Milliseconds
Reporting Level: Application, Operator, Task, Parallelism
Default: maximum over 5 minutes
metricCurrentOutputWatermark
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricCurrentOutputWatermark()
Units: Milliseconds
Reporting Level: Application, Operator, Task, Parallelism
Default: maximum over 5 minutes
metricCurrentOutputWatermark
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricDowntime(@Nullable MetricOptions props)
Units: Milliseconds
Reporting Level: Application
Default: average over 5 minutes
metricDowntime
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricDowntime()
Units: Milliseconds
Reporting Level: Application
Default: average over 5 minutes
metricDowntime
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricFullRestarts(@Nullable MetricOptions props)
This metric does not measure fine-grained restarts.
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
metricFullRestarts
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricFullRestarts()
This metric does not measure fine-grained restarts.
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
metricFullRestarts
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricHeapMemoryUtilization(@Nullable MetricOptions props)
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
metricHeapMemoryUtilization
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricHeapMemoryUtilization()
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
metricHeapMemoryUtilization
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricIdleTimeMsPerSecond(@Nullable MetricOptions props)
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
metricIdleTimeMsPerSecond
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricIdleTimeMsPerSecond()
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
metricIdleTimeMsPerSecond
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricKpus(@Nullable MetricOptions props)
The average number of KPUs used each hour determines the billing for your application.
Units: Count
Reporting Level: Application
Default: average over 5 minutes
metricKpus
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricKpus()
The average number of KPUs used each hour determines the billing for your application.
Units: Count
Reporting Level: Application
Default: average over 5 minutes
metricKpus
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricLastCheckpointDuration(@Nullable MetricOptions props)
Units: Milliseconds
Reporting Level: Application
Default: maximum over 5 minutes
metricLastCheckpointDuration
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricLastCheckpointDuration()
Units: Milliseconds
Reporting Level: Application
Default: maximum over 5 minutes
metricLastCheckpointDuration
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricLastCheckpointSize(@Nullable MetricOptions props)
Units: Bytes
Reporting Level: Application
Default: maximum over 5 minutes
metricLastCheckpointSize
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricLastCheckpointSize()
Units: Bytes
Reporting Level: Application
Default: maximum over 5 minutes
metricLastCheckpointSize
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricManagedMemoryTotal(@Nullable MetricOptions props)
Units: Bytes
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricManagedMemoryTotal
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricManagedMemoryTotal()
Units: Bytes
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricManagedMemoryTotal
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricManagedMemoryUsed(@Nullable MetricOptions props)
Units: Bytes
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricManagedMemoryUsed
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricManagedMemoryUsed()
Units: Bytes
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricManagedMemoryUsed
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricManagedMemoryUtilization(@Nullable MetricOptions props)
Units: Percentage
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricManagedMemoryUtilization
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricManagedMemoryUtilization()
Units: Percentage
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricManagedMemoryUtilization
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricNumberOfFailedCheckpoints(@Nullable MetricOptions props)
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
metricNumberOfFailedCheckpoints
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricNumberOfFailedCheckpoints()
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
metricNumberOfFailedCheckpoints
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricNumLateRecordsDropped(@Nullable MetricOptions props)
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: sum over 5 minutes
metricNumLateRecordsDropped
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricNumLateRecordsDropped()
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: sum over 5 minutes
metricNumLateRecordsDropped
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricNumRecordsIn(@Nullable MetricOptions props)
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsIn
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricNumRecordsIn()
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsIn
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricNumRecordsInPerSecond(@Nullable MetricOptions props)
Units: Count/Second
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsInPerSecond
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricNumRecordsInPerSecond()
Units: Count/Second
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsInPerSecond
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricNumRecordsOut(@Nullable MetricOptions props)
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsOut
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricNumRecordsOut()
Units: Count
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsOut
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricNumRecordsOutPerSecond(@Nullable MetricOptions props)
Units: Count/Second
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsOutPerSecond
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricNumRecordsOutPerSecond()
Units: Count/Second
Reporting Level: Application, Operator, Task, Parallelism
Default: average over 5 minutes
metricNumRecordsOutPerSecond
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricOldGenerationGCCount(@Nullable MetricOptions props)
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
metricOldGenerationGCCount
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricOldGenerationGCCount()
Units: Count
Reporting Level: Application
Default: sum over 5 minutes
metricOldGenerationGCCount
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricOldGenerationGCTime(@Nullable MetricOptions props)
Units: Milliseconds
Reporting Level: Application
Default: sum over 5 minutes
metricOldGenerationGCTime
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricOldGenerationGCTime()
Units: Milliseconds
Reporting Level: Application
Default: sum over 5 minutes
metricOldGenerationGCTime
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricThreadsCount(@Nullable MetricOptions props)
Units: Count
Reporting Level: Application
Default: average over 5 minutes
metricThreadsCount
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricThreadsCount()
Units: Count
Reporting Level: Application
Default: average over 5 minutes
metricThreadsCount
in interface IApplication
@Stability(value=Experimental) @NotNull public Metric metricUptime(@Nullable MetricOptions props)
Units: Milliseconds
Reporting Level: Application
Default: average over 5 minutes
metricUptime
in interface IApplication
props
- @Stability(value=Experimental) @NotNull public Metric metricUptime()
Units: Milliseconds
Reporting Level: Application
Default: average over 5 minutes
metricUptime
in interface IApplication
@Stability(value=Experimental) @NotNull public String getApplicationArn()
getApplicationArn
in interface IApplication
@Stability(value=Experimental) @NotNull public String getApplicationName()
getApplicationName
in interface IApplication
@Stability(value=Experimental) @NotNull public IPrincipal getGrantPrincipal()
getGrantPrincipal
in interface IGrantable
@Stability(value=Experimental) @Nullable public IRole getRole()
getRole
in interface IApplication
Copyright © 2023. All rights reserved.