Application

class aws_cdk.aws_kinesisanalytics_flink.Application(scope, id, *, code, runtime, application_name=None, auto_scaling_enabled=None, checkpointing_enabled=None, checkpoint_interval=None, log_group=None, log_level=None, metrics_level=None, min_pause_between_checkpoints=None, parallelism=None, parallelism_per_kpu=None, property_groups=None, removal_policy=None, role=None, snapshots_enabled=None)

Bases: Resource

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

Stability:: experimental
Resource:: AWS::KinesisAnalyticsV2::Application
ExampleMetadata:: lit=test/integ.application.lit.ts ! show infused

Example:

import path as path
import aws_cdk.core as core
import aws_cdk.aws_kinesisanalytics_flink as flink
import aws_cdk.aws_cloudwatch as cloudwatch

app = core.App()
stack = core.Stack(app, "FlinkAppTest")

flink_app = flink.Application(stack, "App",
    code=flink.ApplicationCode.from_asset(path.join(__dirname, "code-asset")),
    runtime=flink.Runtime.FLINK_1_11
)

cloudwatch.Alarm(stack, "Alarm",
    metric=flink_app.metric_full_restarts(),
    evaluation_periods=1,
    threshold=3
)

app.synth()

Parameters:

scope (Construct) –
id (str) –
code (ApplicationCode) – (experimental) The Flink code asset to run.
runtime (Runtime) – (experimental) The Flink version to use for this application.
application_name (Optional[str]) – (experimental) A name for your Application that is unique to an AWS account. Default: - CloudFormation-generated name
auto_scaling_enabled (Optional[bool]) – (experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage. Default: true
checkpointing_enabled (Optional[bool]) – (experimental) Whether checkpointing is enabled while your application runs. Default: true
checkpoint_interval (Optional[Duration]) – (experimental) The interval between checkpoints. Default: 1 minute
log_group (Optional[ILogGroup]) – (experimental) The log group to send log entries to. Default: CDK’s default LogGroup
log_level (Optional[LogLevel]) – (experimental) The level of log verbosity from the Flink application. Default: FlinkLogLevel.INFO
metrics_level (Optional[MetricsLevel]) – (experimental) Describes the granularity of the CloudWatch metrics for an application. Use caution with Parallelism level metrics. Parallelism granularity logs metrics for each parallel thread and can quickly become expensive when parallelism is high (e.g. > 64). Default: MetricsLevel.APPLICATION
min_pause_between_checkpoints (Optional[Duration]) – (experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint. Default: 5 seconds
parallelism (Union[int, float, None]) – (experimental) The initial parallelism for the application. Kinesis Data Analytics can stop the app, increase the parallelism, and start the app again if autoScalingEnabled is true (the default value). Default: 1
parallelism_per_kpu (Union[int, float, None]) – (experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU). Default: 1
property_groups (Union[PropertyGroups, Dict[str, Any], None]) – (experimental) Configuration PropertyGroups. You can use these property groups to pass arbitrary runtime configuration values to your Flink app. Default: No property group configuration provided to the Flink app
removal_policy (Optional[RemovalPolicy]) – (experimental) Provide a RemovalPolicy to override the default. Default: RemovalPolicy.DESTROY
role (Optional[IRole]) – (experimental) A role to use to grant permissions to your application. Prefer omitting this property and using the default role. Default: - a new Role will be created
snapshots_enabled (Optional[bool]) – (experimental) Determines if Flink snapshots are enabled. Default: true

Stability:

experimental

Methods

add_to_role_policy(policy_statement)

(experimental) Implement the convenience {@link IApplication.addToPrincipalPolicy} method.

Parameters:

policy_statement (PolicyStatement) –

Stability:

experimental

Return type:

bool

apply_removal_policy(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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

metric(metric_name, *, account=None, color=None, dimensions=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)

(experimental) Return a CloudWatch metric associated with this Flink application.

Parameters:

metric_name (str) – The name of the metric.
account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Stability:

experimental

Return type: