Class Application

(experimental) The L2 construct for Flink Kinesis Data Applications.

Inheritance

object

Resource

Application

Implements

IApplication

IResource

IConstruct

IDependable

IEnvironmentAware

IConnectable

IGrantable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyCrossStackReferenceStrength(ReferenceStrength)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.With(params IMixin[])

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Kinesisanalytics.Flink.Alpha

Assembly: Amazon.CDK.AWS.KinesisAnalyticsFlink.Alpha.dll

Syntax (csharp)

public class Application : Resource, IApplication, IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable, IGrantable

Syntax (vb)

Public Class Application Inherits Resource Implements IApplication, IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable, IGrantable

Remarks

Stability: Experimental

Resource: AWS::KinesisAnalyticsV2::Application

ExampleMetadata: infused

Examples

Bucket bucket;

             var flinkApp = new Application(this, "Application", new ApplicationProps {
                 PropertyGroups = new Dictionary<string, IDictionary<string, string>> {
                     { "FlinkApplicationProperties", new Dictionary<string, string> {
                         { "inputStreamName", "my-input-kinesis-stream" },
                         { "outputStreamName", "my-output-kinesis-stream" }
                     } }
                 },
                 // ...
                 Runtime = Runtime.FLINK_1_20,
                 Code = ApplicationCode.FromBucket(bucket, "my-app.jar")
             });

Synopsis

Constructors

Application(Construct, string, IApplicationProps)

(experimental) The L2 construct for Flink Kinesis Data Applications.

Properties

ApplicationArn	(experimental) The application ARN.
ApplicationName	(experimental) The name of the Flink application.
Connections	(experimental) The network connections associated with this resource.
GrantPrincipal	(experimental) The principal to grant permissions to.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.
Role	(experimental) The application IAM role.

Methods

AddToRolePolicy(PolicyStatement)	(experimental) Implement the convenience `IApplication.addToPrincipalPolicy` method.
FromApplicationArn(Construct, string, string)	(experimental) Import an existing application defined outside of CDK code by applicationArn.
FromApplicationAttributes(Construct, string, IApplicationAttributes)	(experimental) Import an existing application defined outside of CDK code.
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.
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.
MetricNumberOfFailedCheckpoints(IMetricOptions?)	(experimental) The number of times checkpointing has failed.
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(Construct, string, IApplicationProps)

(experimental) The L2 construct for Flink Kinesis Data Applications.

public Application(Construct scope, string id, IApplicationProps props)

Parameters

scope Construct
id string
props IApplicationProps

Remarks

Stability: Experimental

Properties

ApplicationArn

(experimental) The application ARN.

public virtual string ApplicationArn { get; }

Property Value

string

Remarks

Stability: Experimental

ApplicationName

(experimental) The name of the Flink application.

public virtual string ApplicationName { get; }

Property Value

string

Remarks

Stability: Experimental

Connections

(experimental) The network connections associated with this resource.

public virtual Connections_ Connections { get; }

Property Value

Connections_

Remarks

Stability: Experimental

GrantPrincipal

(experimental) The principal to grant permissions to.

public virtual IPrincipal GrantPrincipal { get; }

Property Value

IPrincipal

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

Role

(experimental) The application IAM role.

public virtual IRole? Role { get; }

Property Value

IRole

Remarks

Stability: Experimental

Methods

AddToRolePolicy(PolicyStatement)

(experimental) Implement the convenience IApplication.addToPrincipalPolicy method.

public virtual bool AddToRolePolicy(PolicyStatement policyStatement)

Parameters

policyStatement PolicyStatement

Returns

bool

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 Construct
id string
applicationArn string

Returns

IApplication

Remarks

Stability: Experimental

FromApplicationAttributes(Construct, string, IApplicationAttributes)

(experimental) Import an existing application defined outside of CDK code.

public static IApplication FromApplicationAttributes(Construct scope, string id, IApplicationAttributes attrs)

Parameters

scope Construct
id string
attrs IApplicationAttributes

Returns

IApplication

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 Construct
id string
applicationName string

Returns

IApplication

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 string: The name of the metric.
props IMetricOptions: Customization properties.

Returns

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

Remarks

Units: Percentage

Reporting Level: Application, Operator, Task, Parallelism

Default: - average 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

Metric

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

Metric

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

Metric

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

Metric

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

Metric

Remarks

Units: Count/Second

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

Metric

Remarks

Units: Count

Reporting Level: Application

Default: - sum 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

Metric

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

Metric

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

Metric

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

Metric

Remarks

Units: Milliseconds

Reporting Level: Application

Default: - average over 5 minutes

Stability: Experimental

Implements

IApplication

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

IConnectable

IGrantable