@aws-cdk/aws-kinesisanalytics-flink-alpha 2.16.0-alpha.0 → 2.19.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "aws-cdk-lib": "^2.16.0",
11
+ "aws-cdk-lib": "^2.19.0",
12
12
  "constructs": "^10.0.0"
13
13
  },
14
14
  "dependencyClosure": {
@@ -378,6 +378,19 @@
378
378
  }
379
379
  }
380
380
  },
381
+ "aws-cdk-lib.aws_billingconductor": {
382
+ "targets": {
383
+ "dotnet": {
384
+ "namespace": "Amazon.CDK.AWS.BillingConductor"
385
+ },
386
+ "java": {
387
+ "package": "software.amazon.awscdk.services.billingconductor"
388
+ },
389
+ "python": {
390
+ "module": "aws_cdk.aws_billingconductor"
391
+ }
392
+ }
393
+ },
381
394
  "aws-cdk-lib.aws_budgets": {
382
395
  "targets": {
383
396
  "dotnet": {
@@ -2043,6 +2056,19 @@
2043
2056
  }
2044
2057
  }
2045
2058
  },
2059
+ "aws-cdk-lib.aws_personalize": {
2060
+ "targets": {
2061
+ "dotnet": {
2062
+ "namespace": "Amazon.CDK.AWS.Personalize"
2063
+ },
2064
+ "java": {
2065
+ "package": "software.amazon.awscdk.services.personalize"
2066
+ },
2067
+ "python": {
2068
+ "module": "aws_cdk.aws_personalize"
2069
+ }
2070
+ }
2071
+ },
2046
2072
  "aws-cdk-lib.aws_pinpoint": {
2047
2073
  "targets": {
2048
2074
  "dotnet": {
@@ -2933,7 +2959,7 @@
2933
2959
  "stability": "experimental"
2934
2960
  },
2935
2961
  "homepage": "https://github.com/aws/aws-cdk",
2936
- "jsiiVersion": "1.54.0 (build b1b977a)",
2962
+ "jsiiVersion": "1.55.1 (build 07d2d90)",
2937
2963
  "keywords": [
2938
2964
  "aws",
2939
2965
  "cdk",
@@ -2956,7 +2982,7 @@
2956
2982
  },
2957
2983
  "name": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
2958
2984
  "readme": {
2959
- "markdown": "# Kinesis Analytics Flink\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nThis package provides constructs for creating Kinesis Analytics Flink\napplications. To learn more about using using managed Flink applications, see\nthe [AWS developer\nguide](https://docs.aws.amazon.com/kinesisanalytics/latest/java/what-is.html).\n\n## Creating Flink Applications\n\nTo create a new Flink application, use the `Application` construct:\n\n```ts lit=test/integ.application.lit.ts\n///! show\nimport * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nnew flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n///! hide\n\napp.synth();\n\n```\n\nThe `code` property can use `fromAsset` as shown above to reference a local jar\nfile in s3 or `fromBucket` to reference a file in s3.\n\n```ts lit=test/integ.application-code-from-bucket.lit.ts\nimport * as path from 'path';\nimport * as assets from 'aws-cdk-lib/aws-s3-assets';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppCodeFromBucketTest');\n\nconst asset = new assets.Asset(stack, 'CodeAsset', {\n path: path.join(__dirname, 'code-asset'),\n});\nconst bucket = asset.bucket;\nconst fileKey = asset.s3ObjectKey;\n\n///! show\nnew flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromBucket(bucket, fileKey),\n runtime: flink.Runtime.FLINK_1_11,\n});\n///! hide\n\napp.synth();\n\n```\n\nThe `propertyGroups` property provides a way of passing arbitrary runtime\nproperties to your Flink application. You can use the\naws-kinesisanalytics-runtime library to [retrieve these\nproperties](https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-properties.html#how-properties-access).\n\n```ts\ndeclare const bucket: s3.Bucket;\nconst flinkApp = new flink.Application(this, 'Application', {\n propertyGroups: {\n FlinkApplicationProperties: {\n inputStreamName: 'my-input-kinesis-stream',\n outputStreamName: 'my-output-kinesis-stream',\n },\n },\n // ...\n runtime: flink.Runtime.FLINK_1_13,\n code: flink.ApplicationCode.fromBucket(bucket, 'my-app.jar'),\n});\n```\n\nFlink applications also have specific configuration for passing parameters\nwhen the Flink job starts. These include parameters for checkpointing,\nsnapshotting, monitoring, and parallelism.\n\n```ts\ndeclare const bucket: s3.Bucket;\nconst flinkApp = new flink.Application(this, 'Application', {\n code: flink.ApplicationCode.fromBucket(bucket, 'my-app.jar'),\n runtime: flink.Runtime.FLINK_1_13,\n checkpointingEnabled: true, // default is true\n checkpointInterval: Duration.seconds(30), // default is 1 minute\n minPauseBetweenCheckpoints: Duration.seconds(10), // default is 5 seconds\n logLevel: flink.LogLevel.ERROR, // default is INFO\n metricsLevel: flink.MetricsLevel.PARALLELISM, // default is APPLICATION\n autoScalingEnabled: false, // default is true\n parallelism: 32, // default is 1\n parallelismPerKpu: 2, // default is 1\n snapshotsEnabled: false, // default is true\n logGroup: new logs.LogGroup(this, 'LogGroup'), // by default, a new LogGroup will be created\n});\n```\n"
2985
+ "markdown": "# Kinesis Analytics Flink\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nThis package provides constructs for creating Kinesis Analytics Flink\napplications. To learn more about using using managed Flink applications, see\nthe [AWS developer\nguide](https://docs.aws.amazon.com/kinesisanalytics/latest/java/).\n\n## Creating Flink Applications\n\nTo create a new Flink application, use the `Application` construct:\n\n```ts lit=test/integ.application.lit.ts\n///! show\nimport * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nconst flinkApp = new flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n\nnew cloudwatch.Alarm(stack, 'Alarm', {\n metric: flinkApp.metricFullRestarts(),\n evaluationPeriods: 1,\n threshold: 3,\n});\n///! hide\n\napp.synth();\n\n```\n\nThe `code` property can use `fromAsset` as shown above to reference a local jar\nfile in s3 or `fromBucket` to reference a file in s3.\n\n```ts lit=test/integ.application-code-from-bucket.lit.ts\nimport * as path from 'path';\nimport * as assets from 'aws-cdk-lib/aws-s3-assets';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppCodeFromBucketTest');\n\nconst asset = new assets.Asset(stack, 'CodeAsset', {\n path: path.join(__dirname, 'code-asset'),\n});\nconst bucket = asset.bucket;\nconst fileKey = asset.s3ObjectKey;\n\n///! show\nnew flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromBucket(bucket, fileKey),\n runtime: flink.Runtime.FLINK_1_11,\n});\n///! hide\n\napp.synth();\n\n```\n\nThe `propertyGroups` property provides a way of passing arbitrary runtime\nproperties to your Flink application. You can use the\naws-kinesisanalytics-runtime library to [retrieve these\nproperties](https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-properties.html#how-properties-access).\n\n```ts\ndeclare const bucket: s3.Bucket;\nconst flinkApp = new flink.Application(this, 'Application', {\n propertyGroups: {\n FlinkApplicationProperties: {\n inputStreamName: 'my-input-kinesis-stream',\n outputStreamName: 'my-output-kinesis-stream',\n },\n },\n // ...\n runtime: flink.Runtime.FLINK_1_13,\n code: flink.ApplicationCode.fromBucket(bucket, 'my-app.jar'),\n});\n```\n\nFlink applications also have specific configuration for passing parameters\nwhen the Flink job starts. These include parameters for checkpointing,\nsnapshotting, monitoring, and parallelism.\n\n```ts\ndeclare const bucket: s3.Bucket;\nconst flinkApp = new flink.Application(this, 'Application', {\n code: flink.ApplicationCode.fromBucket(bucket, 'my-app.jar'),\n runtime: flink.Runtime.FLINK_1_13,\n checkpointingEnabled: true, // default is true\n checkpointInterval: Duration.seconds(30), // default is 1 minute\n minPauseBetweenCheckpoints: Duration.seconds(10), // default is 5 seconds\n logLevel: flink.LogLevel.ERROR, // default is INFO\n metricsLevel: flink.MetricsLevel.PARALLELISM, // default is APPLICATION\n autoScalingEnabled: false, // default is true\n parallelism: 32, // default is 1\n parallelismPerKpu: 2, // default is 1\n snapshotsEnabled: false, // default is true\n logGroup: new logs.LogGroup(this, 'LogGroup'), // by default, a new LogGroup will be created\n});\n```\n"
2960
2986
  },
2961
2987
  "repository": {
2962
2988
  "directory": "packages/individual-packages/aws-kinesisanalytics-flink",
@@ -2987,7 +3013,7 @@
2987
3013
  "python": {
2988
3014
  "classifiers": [
2989
3015
  "Framework :: AWS CDK",
2990
- "Framework :: AWS CDK :: 1"
3016
+ "Framework :: AWS CDK :: 2"
2991
3017
  ],
2992
3018
  "distName": "aws-cdk.aws-kinesisanalytics-flink-alpha",
2993
3019
  "module": "aws_cdk.aws_kinesisanalytics_flink_alpha"
@@ -3002,7 +3028,7 @@
3002
3028
  "exampleMetadata": "lit=test/integ.application.lit.ts ! show infused",
3003
3029
  "resource": "AWS::KinesisAnalyticsV2::Application"
3004
3030
  },
3005
- "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nnew flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n///! hide\n\napp.synth();",
3031
+ "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nconst flinkApp = new flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n\nnew cloudwatch.Alarm(stack, 'Alarm', {\n metric: flinkApp.metricFullRestarts(),\n evaluationPeriods: 1,\n threshold: 3,\n});\n///! hide\n\napp.synth();",
3006
3032
  "stability": "experimental",
3007
3033
  "summary": "The L2 construct for Flink Kinesis Data Applications."
3008
3034
  },
@@ -3013,7 +3039,7 @@
3013
3039
  },
3014
3040
  "locationInModule": {
3015
3041
  "filename": "lib/application.ts",
3016
- "line": 246
3042
+ "line": 904
3017
3043
  },
3018
3044
  "parameters": [
3019
3045
  {
@@ -3042,7 +3068,7 @@
3042
3068
  "kind": "class",
3043
3069
  "locationInModule": {
3044
3070
  "filename": "lib/application.ts",
3045
- "line": 214
3071
+ "line": 872
3046
3072
  },
3047
3073
  "methods": [
3048
3074
  {
@@ -3052,7 +3078,7 @@
3052
3078
  },
3053
3079
  "locationInModule": {
3054
3080
  "filename": "lib/application.ts",
3055
- "line": 229
3081
+ "line": 887
3056
3082
  },
3057
3083
  "name": "fromApplicationArn",
3058
3084
  "parameters": [
@@ -3089,7 +3115,7 @@
3089
3115
  },
3090
3116
  "locationInModule": {
3091
3117
  "filename": "lib/application.ts",
3092
- "line": 219
3118
+ "line": 877
3093
3119
  },
3094
3120
  "name": "fromApplicationName",
3095
3121
  "parameters": [
@@ -3126,7 +3152,7 @@
3126
3152
  },
3127
3153
  "locationInModule": {
3128
3154
  "filename": "lib/application.ts",
3129
- "line": 55
3155
+ "line": 355
3130
3156
  },
3131
3157
  "name": "addToRolePolicy",
3132
3158
  "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
@@ -3143,618 +3169,2094 @@
3143
3169
  "primitive": "boolean"
3144
3170
  }
3145
3171
  }
3146
- }
3147
- ],
3148
- "name": "Application",
3149
- "properties": [
3172
+ },
3150
3173
  {
3151
3174
  "docs": {
3152
3175
  "stability": "experimental",
3153
- "summary": "The application ARN."
3176
+ "summary": "Return a CloudWatch metric associated with this Flink application."
3154
3177
  },
3155
- "immutable": true,
3156
3178
  "locationInModule": {
3157
3179
  "filename": "lib/application.ts",
3158
- "line": 238
3180
+ "line": 370
3159
3181
  },
3160
- "name": "applicationArn",
3182
+ "name": "metric",
3161
3183
  "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3162
- "type": {
3163
- "primitive": "string"
3184
+ "parameters": [
3185
+ {
3186
+ "docs": {
3187
+ "summary": "The name of the metric."
3188
+ },
3189
+ "name": "metricName",
3190
+ "type": {
3191
+ "primitive": "string"
3192
+ }
3193
+ },
3194
+ {
3195
+ "docs": {
3196
+ "summary": "Customization properties."
3197
+ },
3198
+ "name": "props",
3199
+ "optional": true,
3200
+ "type": {
3201
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3202
+ }
3203
+ }
3204
+ ],
3205
+ "returns": {
3206
+ "type": {
3207
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3208
+ }
3164
3209
  }
3165
3210
  },
3166
3211
  {
3167
3212
  "docs": {
3213
+ "default": "average over 5 minutes",
3214
+ "remarks": "Units: Milliseconds\n\nReporting Level: Operator, Task, Parallelism",
3168
3215
  "stability": "experimental",
3169
- "summary": "The name of the Flink application."
3216
+ "summary": "The time (in milliseconds) this task or operator is back pressured per second."
3170
3217
  },
3171
- "immutable": true,
3172
3218
  "locationInModule": {
3173
3219
  "filename": "lib/application.ts",
3174
- "line": 239
3220
+ "line": 703
3175
3221
  },
3176
- "name": "applicationName",
3222
+ "name": "metricBackPressuredTimeMsPerSecond",
3177
3223
  "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3178
- "type": {
3179
- "primitive": "string"
3224
+ "parameters": [
3225
+ {
3226
+ "name": "props",
3227
+ "optional": true,
3228
+ "type": {
3229
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3230
+ }
3231
+ }
3232
+ ],
3233
+ "returns": {
3234
+ "type": {
3235
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3236
+ }
3180
3237
  }
3181
3238
  },
3182
3239
  {
3183
3240
  "docs": {
3241
+ "default": "average over 5 minutes",
3242
+ "remarks": "Can be NaN, if the value could not be\ncalculated.\n\nUnits: Milliseconds\n\nReporting Level: Operator, Task, Parallelism",
3184
3243
  "stability": "experimental",
3185
- "summary": "The principal to grant permissions to."
3244
+ "summary": "The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second."
3186
3245
  },
3187
- "immutable": true,
3188
3246
  "locationInModule": {
3189
3247
  "filename": "lib/application.ts",
3190
- "line": 244
3248
+ "line": 718
3191
3249
  },
3192
- "name": "grantPrincipal",
3193
- "overrides": "aws-cdk-lib.aws_iam.IGrantable",
3194
- "type": {
3195
- "fqn": "aws-cdk-lib.aws_iam.IPrincipal"
3250
+ "name": "metricBusyTimePerMsPerSecond",
3251
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3252
+ "parameters": [
3253
+ {
3254
+ "name": "props",
3255
+ "optional": true,
3256
+ "type": {
3257
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3258
+ }
3259
+ }
3260
+ ],
3261
+ "returns": {
3262
+ "type": {
3263
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3264
+ }
3196
3265
  }
3197
3266
  },
3198
3267
  {
3199
3268
  "docs": {
3269
+ "default": "average over 5 minutes",
3270
+ "remarks": "For\nexample, if there are five task managers, Kinesis Data Analytics publishes\nfive samples of this metric per reporting interval.\n\nUnits: Percentage\n\nReporting Level: Application",
3200
3271
  "stability": "experimental",
3201
- "summary": "The application IAM role."
3272
+ "summary": "The overall percentage of CPU utilization across task managers."
3202
3273
  },
3203
- "immutable": true,
3204
3274
  "locationInModule": {
3205
3275
  "filename": "lib/application.ts",
3206
- "line": 242
3276
+ "line": 485
3207
3277
  },
3208
- "name": "role",
3209
- "optional": true,
3278
+ "name": "metricCpuUtilization",
3210
3279
  "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3211
- "type": {
3212
- "fqn": "aws-cdk-lib.aws_iam.IRole"
3280
+ "parameters": [
3281
+ {
3282
+ "name": "props",
3283
+ "optional": true,
3284
+ "type": {
3285
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3286
+ }
3287
+ }
3288
+ ],
3289
+ "returns": {
3290
+ "type": {
3291
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3292
+ }
3213
3293
  }
3214
- }
3215
- ],
3216
- "symbolId": "lib/application:Application"
3217
- },
3218
- "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode": {
3219
- "abstract": true,
3220
- "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
3221
- "docs": {
3222
- "custom": {
3223
- "exampleMetadata": "lit=test/integ.application.lit.ts ! show infused"
3224
3294
  },
3225
- "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nnew flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n///! hide\n\napp.synth();",
3226
- "stability": "experimental",
3227
- "summary": "Code configuration providing the location to a Flink application JAR file."
3228
- },
3229
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode",
3230
- "initializer": {
3231
- "docs": {
3232
- "stability": "experimental"
3233
- }
3234
- },
3235
- "kind": "class",
3236
- "locationInModule": {
3237
- "filename": "lib/application-code.ts",
3238
- "line": 26
3239
- },
3240
- "methods": [
3241
3295
  {
3242
3296
  "docs": {
3243
- "custom": {
3244
- "parm": "options - standard s3 AssetOptions"
3245
- },
3297
+ "default": "maximum over 5 minutes",
3298
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application, Operator, Task, Parallelism",
3246
3299
  "stability": "experimental",
3247
- "summary": "Reference code from a local directory containing a Flink JAR file."
3300
+ "summary": "The last watermark this application/operator/task/thread has received."
3248
3301
  },
3249
3302
  "locationInModule": {
3250
- "filename": "lib/application-code.ts",
3251
- "line": 48
3303
+ "filename": "lib/application.ts",
3304
+ "line": 622
3252
3305
  },
3253
- "name": "fromAsset",
3306
+ "name": "metricCurrentInputWatermark",
3307
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3254
3308
  "parameters": [
3255
3309
  {
3256
- "docs": {
3257
- "summary": "- a local directory path."
3258
- },
3259
- "name": "path",
3260
- "type": {
3261
- "primitive": "string"
3262
- }
3263
- },
3264
- {
3265
- "name": "options",
3310
+ "name": "props",
3266
3311
  "optional": true,
3267
3312
  "type": {
3268
- "fqn": "aws-cdk-lib.aws_s3_assets.AssetOptions"
3313
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3269
3314
  }
3270
3315
  }
3271
3316
  ],
3272
3317
  "returns": {
3273
3318
  "type": {
3274
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode"
3319
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3275
3320
  }
3276
- },
3277
- "static": true
3321
+ }
3278
3322
  },
3279
3323
  {
3280
3324
  "docs": {
3325
+ "default": "maximum over 5 minutes",
3326
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application, Operator, Task, Parallelism",
3281
3327
  "stability": "experimental",
3282
- "summary": "Reference code from an S3 bucket."
3328
+ "summary": "The last watermark this application/operator/task/thread has received."
3283
3329
  },
3284
3330
  "locationInModule": {
3285
- "filename": "lib/application-code.ts",
3286
- "line": 34
3331
+ "filename": "lib/application.ts",
3332
+ "line": 635
3287
3333
  },
3288
- "name": "fromBucket",
3334
+ "name": "metricCurrentOutputWatermark",
3335
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3289
3336
  "parameters": [
3290
3337
  {
3291
- "docs": {
3292
- "summary": "- an s3 bucket."
3293
- },
3294
- "name": "bucket",
3295
- "type": {
3296
- "fqn": "aws-cdk-lib.aws_s3.IBucket"
3297
- }
3298
- },
3299
- {
3300
- "docs": {
3301
- "summary": "- a key pointing to a Flink JAR file."
3302
- },
3303
- "name": "fileKey",
3338
+ "name": "props",
3339
+ "optional": true,
3304
3340
  "type": {
3305
- "primitive": "string"
3341
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3306
3342
  }
3307
- },
3343
+ }
3344
+ ],
3345
+ "returns": {
3346
+ "type": {
3347
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3348
+ }
3349
+ }
3350
+ },
3351
+ {
3352
+ "docs": {
3353
+ "default": "average over 5 minutes",
3354
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
3355
+ "stability": "experimental",
3356
+ "summary": "The time elapsed during an outage for failing/recovering jobs."
3357
+ },
3358
+ "locationInModule": {
3359
+ "filename": "lib/application.ts",
3360
+ "line": 404
3361
+ },
3362
+ "name": "metricDowntime",
3363
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3364
+ "parameters": [
3308
3365
  {
3309
- "docs": {
3310
- "summary": "- an optional version string for the provided fileKey."
3311
- },
3312
- "name": "objectVersion",
3366
+ "name": "props",
3313
3367
  "optional": true,
3314
3368
  "type": {
3315
- "primitive": "string"
3369
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3316
3370
  }
3317
3371
  }
3318
3372
  ],
3319
3373
  "returns": {
3320
3374
  "type": {
3321
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode"
3375
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3322
3376
  }
3323
- },
3324
- "static": true
3377
+ }
3325
3378
  },
3326
3379
  {
3327
- "abstract": true,
3328
3380
  "docs": {
3381
+ "default": "sum over 5 minutes",
3382
+ "remarks": "This metric does not measure fine-grained restarts.\n\nUnits: Count\n\nReporting Level: Application",
3329
3383
  "stability": "experimental",
3330
- "summary": "A method to lazily bind asset resources to the parent FlinkApplication."
3384
+ "summary": "The total number of times this job has fully restarted since it was submitted."
3331
3385
  },
3332
3386
  "locationInModule": {
3333
- "filename": "lib/application-code.ts",
3334
- "line": 55
3387
+ "filename": "lib/application.ts",
3388
+ "line": 431
3335
3389
  },
3336
- "name": "bind",
3390
+ "name": "metricFullRestarts",
3391
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3337
3392
  "parameters": [
3338
3393
  {
3339
- "name": "scope",
3394
+ "name": "props",
3395
+ "optional": true,
3340
3396
  "type": {
3341
- "fqn": "constructs.Construct"
3397
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3342
3398
  }
3343
3399
  }
3344
3400
  ],
3345
3401
  "returns": {
3346
3402
  "type": {
3347
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCodeConfig"
3403
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3348
3404
  }
3349
3405
  }
3350
- }
3351
- ],
3352
- "name": "ApplicationCode",
3353
- "symbolId": "lib/application-code:ApplicationCode"
3354
- },
3355
- "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCodeConfig": {
3356
- "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
3357
- "datatype": true,
3358
- "docs": {
3359
- "stability": "experimental",
3360
- "summary": "The return type of {@link ApplicationCode.bind}. This represents CloudFormation configuration and an s3 bucket holding the Flink application JAR file.",
3361
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kinesisanalytics_flink_alpha from '@aws-cdk/aws-kinesisanalytics-flink-alpha';\nimport { aws_s3 as s3 } from 'aws-cdk-lib';\n\ndeclare const bucket: s3.Bucket;\ndeclare const propertyMap: any;\nconst applicationCodeConfig: kinesisanalytics_flink_alpha.ApplicationCodeConfig = {\n applicationCodeConfigurationProperty: {\n applicationCodeConfiguration: {\n codeContent: {\n s3ContentLocation: {\n bucketArn: 'bucketArn',\n fileKey: 'fileKey',\n objectVersion: 'objectVersion',\n },\n textContent: 'textContent',\n zipFileContent: 'zipFileContent',\n },\n codeContentType: 'codeContentType',\n },\n applicationSnapshotConfiguration: {\n snapshotsEnabled: false,\n },\n environmentProperties: {\n propertyGroups: [{\n propertyGroupId: 'propertyGroupId',\n propertyMap: propertyMap,\n }],\n },\n flinkApplicationConfiguration: {\n checkpointConfiguration: {\n configurationType: 'configurationType',\n\n // the properties below are optional\n checkpointingEnabled: false,\n checkpointInterval: 123,\n minPauseBetweenCheckpoints: 123,\n },\n monitoringConfiguration: {\n configurationType: 'configurationType',\n\n // the properties below are optional\n logLevel: 'logLevel',\n metricsLevel: 'metricsLevel',\n },\n parallelismConfiguration: {\n configurationType: 'configurationType',\n\n // the properties below are optional\n autoScalingEnabled: false,\n parallelism: 123,\n parallelismPerKpu: 123,\n },\n },\n sqlApplicationConfiguration: {\n inputs: [{\n inputSchema: {\n recordColumns: [{\n name: 'name',\n sqlType: 'sqlType',\n\n // the properties below are optional\n mapping: 'mapping',\n }],\n recordFormat: {\n recordFormatType: 'recordFormatType',\n\n // the properties below are optional\n mappingParameters: {\n csvMappingParameters: {\n recordColumnDelimiter: 'recordColumnDelimiter',\n recordRowDelimiter: 'recordRowDelimiter',\n },\n jsonMappingParameters: {\n recordRowPath: 'recordRowPath',\n },\n },\n },\n\n // the properties below are optional\n recordEncoding: 'recordEncoding',\n },\n namePrefix: 'namePrefix',\n\n // the properties below are optional\n inputParallelism: {\n count: 123,\n },\n inputProcessingConfiguration: {\n inputLambdaProcessor: {\n resourceArn: 'resourceArn',\n },\n },\n kinesisFirehoseInput: {\n resourceArn: 'resourceArn',\n },\n kinesisStreamsInput: {\n resourceArn: 'resourceArn',\n },\n }],\n },\n zeppelinApplicationConfiguration: {\n catalogConfiguration: {\n glueDataCatalogConfiguration: {\n databaseArn: 'databaseArn',\n },\n },\n customArtifactsConfiguration: [{\n artifactType: 'artifactType',\n\n // the properties below are optional\n mavenReference: {\n artifactId: 'artifactId',\n groupId: 'groupId',\n version: 'version',\n },\n s3ContentLocation: {\n bucketArn: 'bucketArn',\n fileKey: 'fileKey',\n objectVersion: 'objectVersion',\n },\n }],\n deployAsApplicationConfiguration: {\n s3ContentLocation: {\n basePath: 'basePath',\n bucketArn: 'bucketArn',\n },\n },\n monitoringConfiguration: {\n logLevel: 'logLevel',\n },\n },\n },\n bucket: bucket,\n};",
3362
- "custom": {
3363
- "exampleMetadata": "fixture=_generated"
3364
- }
3365
- },
3366
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCodeConfig",
3367
- "kind": "interface",
3368
- "locationInModule": {
3369
- "filename": "lib/application-code.ts",
3370
- "line": 11
3371
- },
3372
- "name": "ApplicationCodeConfig",
3373
- "properties": [
3406
+ },
3374
3407
  {
3375
- "abstract": true,
3376
3408
  "docs": {
3409
+ "default": "average over 5 minutes",
3410
+ "remarks": "For example, if there\nare five task managers, Kinesis Data Analytics publishes five samples of\nthis metric per reporting interval.\n\nUnits: Percentage\n\nReporting Level: Application",
3377
3411
  "stability": "experimental",
3378
- "summary": "Low-level Cloudformation ApplicationConfigurationProperty."
3412
+ "summary": "Overall heap memory utilization across task managers."
3379
3413
  },
3380
- "immutable": true,
3381
3414
  "locationInModule": {
3382
- "filename": "lib/application-code.ts",
3383
- "line": 15
3415
+ "filename": "lib/application.ts",
3416
+ "line": 500
3384
3417
  },
3385
- "name": "applicationCodeConfigurationProperty",
3386
- "type": {
3387
- "fqn": "aws-cdk-lib.aws_kinesisanalytics.CfnApplicationV2.ApplicationConfigurationProperty"
3418
+ "name": "metricHeapMemoryUtilization",
3419
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3420
+ "parameters": [
3421
+ {
3422
+ "name": "props",
3423
+ "optional": true,
3424
+ "type": {
3425
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3426
+ }
3427
+ }
3428
+ ],
3429
+ "returns": {
3430
+ "type": {
3431
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3432
+ }
3388
3433
  }
3389
3434
  },
3390
3435
  {
3391
- "abstract": true,
3392
3436
  "docs": {
3437
+ "default": "average over 5 minutes",
3438
+ "remarks": "Idle time excludes back pressured time, so if the task\nis back pressured it is not idle.\n\nUnits: Milliseconds\n\nReporting Level: Operator, Task, Parallelism",
3393
3439
  "stability": "experimental",
3394
- "summary": "S3 Bucket that stores the Flink application code."
3440
+ "summary": "The time (in milliseconds) this task or operator is idle (has no data to process) per second."
3395
3441
  },
3396
- "immutable": true,
3397
3442
  "locationInModule": {
3398
- "filename": "lib/application-code.ts",
3399
- "line": 20
3443
+ "filename": "lib/application.ts",
3444
+ "line": 689
3400
3445
  },
3401
- "name": "bucket",
3402
- "type": {
3446
+ "name": "metricIdleTimeMsPerSecond",
3447
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3448
+ "parameters": [
3449
+ {
3450
+ "name": "props",
3451
+ "optional": true,
3452
+ "type": {
3453
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3454
+ }
3455
+ }
3456
+ ],
3457
+ "returns": {
3458
+ "type": {
3459
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3460
+ }
3461
+ }
3462
+ },
3463
+ {
3464
+ "docs": {
3465
+ "default": "average over 5 minutes",
3466
+ "remarks": "The average number of KPUs used each hour\ndetermines the billing for your application.\n\nUnits: Count\n\nReporting Level: Application",
3467
+ "stability": "experimental",
3468
+ "summary": "The number of Kinesis Processing Units that are used to run your stream processing application."
3469
+ },
3470
+ "locationInModule": {
3471
+ "filename": "lib/application.ts",
3472
+ "line": 390
3473
+ },
3474
+ "name": "metricKpus",
3475
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3476
+ "parameters": [
3477
+ {
3478
+ "name": "props",
3479
+ "optional": true,
3480
+ "type": {
3481
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3482
+ }
3483
+ }
3484
+ ],
3485
+ "returns": {
3486
+ "type": {
3487
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3488
+ }
3489
+ }
3490
+ },
3491
+ {
3492
+ "docs": {
3493
+ "default": "maximum over 5 minutes",
3494
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
3495
+ "stability": "experimental",
3496
+ "summary": "The time it took to complete the last checkpoint."
3497
+ },
3498
+ "locationInModule": {
3499
+ "filename": "lib/application.ts",
3500
+ "line": 457
3501
+ },
3502
+ "name": "metricLastCheckpointDuration",
3503
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3504
+ "parameters": [
3505
+ {
3506
+ "name": "props",
3507
+ "optional": true,
3508
+ "type": {
3509
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3510
+ }
3511
+ }
3512
+ ],
3513
+ "returns": {
3514
+ "type": {
3515
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3516
+ }
3517
+ }
3518
+ },
3519
+ {
3520
+ "docs": {
3521
+ "default": "maximum over 5 minutes",
3522
+ "remarks": "Units: Bytes\n\nReporting Level: Application",
3523
+ "stability": "experimental",
3524
+ "summary": "The total size of the last checkpoint."
3525
+ },
3526
+ "locationInModule": {
3527
+ "filename": "lib/application.ts",
3528
+ "line": 470
3529
+ },
3530
+ "name": "metricLastCheckpointSize",
3531
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3532
+ "parameters": [
3533
+ {
3534
+ "name": "props",
3535
+ "optional": true,
3536
+ "type": {
3537
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3538
+ }
3539
+ }
3540
+ ],
3541
+ "returns": {
3542
+ "type": {
3543
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3544
+ }
3545
+ }
3546
+ },
3547
+ {
3548
+ "docs": {
3549
+ "default": "average over 5 minutes",
3550
+ "remarks": "Units: Bytes\n\nReporting Level: Application, Operator, Task, Parallelism",
3551
+ "stability": "experimental",
3552
+ "summary": "The total amount of managed memory."
3553
+ },
3554
+ "locationInModule": {
3555
+ "filename": "lib/application.ts",
3556
+ "line": 661
3557
+ },
3558
+ "name": "metricManagedMemoryTotal",
3559
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3560
+ "parameters": [
3561
+ {
3562
+ "name": "props",
3563
+ "optional": true,
3564
+ "type": {
3565
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3566
+ }
3567
+ }
3568
+ ],
3569
+ "returns": {
3570
+ "type": {
3571
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3572
+ }
3573
+ }
3574
+ },
3575
+ {
3576
+ "docs": {
3577
+ "default": "average over 5 minutes",
3578
+ "remarks": "Units: Bytes\n\nReporting Level: Application, Operator, Task, Parallelism",
3579
+ "stability": "experimental",
3580
+ "summary": "The amount of managed memory currently used."
3581
+ },
3582
+ "locationInModule": {
3583
+ "filename": "lib/application.ts",
3584
+ "line": 648
3585
+ },
3586
+ "name": "metricManagedMemoryUsed",
3587
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3588
+ "parameters": [
3589
+ {
3590
+ "name": "props",
3591
+ "optional": true,
3592
+ "type": {
3593
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3594
+ }
3595
+ }
3596
+ ],
3597
+ "returns": {
3598
+ "type": {
3599
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3600
+ }
3601
+ }
3602
+ },
3603
+ {
3604
+ "docs": {
3605
+ "default": "average over 5 minutes",
3606
+ "remarks": "Units: Percentage\n\nReporting Level: Application, Operator, Task, Parallelism",
3607
+ "stability": "experimental",
3608
+ "summary": "Derived from managedMemoryUsed/managedMemoryTotal."
3609
+ },
3610
+ "locationInModule": {
3611
+ "filename": "lib/application.ts",
3612
+ "line": 674
3613
+ },
3614
+ "name": "metricManagedMemoryUtilization",
3615
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3616
+ "parameters": [
3617
+ {
3618
+ "name": "props",
3619
+ "optional": true,
3620
+ "type": {
3621
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3622
+ }
3623
+ }
3624
+ ],
3625
+ "returns": {
3626
+ "type": {
3627
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3628
+ }
3629
+ }
3630
+ },
3631
+ {
3632
+ "docs": {
3633
+ "default": "sum over 5 minutes",
3634
+ "remarks": "Units: Count\n\nReporting Level: Application",
3635
+ "stability": "experimental",
3636
+ "summary": "The number of times checkpointing has failed."
3637
+ },
3638
+ "locationInModule": {
3639
+ "filename": "lib/application.ts",
3640
+ "line": 444
3641
+ },
3642
+ "name": "metricNumberOfFailedCheckpoints",
3643
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3644
+ "parameters": [
3645
+ {
3646
+ "name": "props",
3647
+ "optional": true,
3648
+ "type": {
3649
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3650
+ }
3651
+ }
3652
+ ],
3653
+ "returns": {
3654
+ "type": {
3655
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3656
+ }
3657
+ }
3658
+ },
3659
+ {
3660
+ "docs": {
3661
+ "default": "sum over 5 minutes",
3662
+ "remarks": "Units: Count\n\nReporting Level: Application, Operator, Task, Parallelism",
3663
+ "stability": "experimental",
3664
+ "summary": "The number of records this operator or task has dropped due to arriving late."
3665
+ },
3666
+ "locationInModule": {
3667
+ "filename": "lib/application.ts",
3668
+ "line": 609
3669
+ },
3670
+ "name": "metricNumLateRecordsDropped",
3671
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3672
+ "parameters": [
3673
+ {
3674
+ "name": "props",
3675
+ "optional": true,
3676
+ "type": {
3677
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3678
+ }
3679
+ }
3680
+ ],
3681
+ "returns": {
3682
+ "type": {
3683
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3684
+ }
3685
+ }
3686
+ },
3687
+ {
3688
+ "docs": {
3689
+ "default": "average over 5 minutes",
3690
+ "remarks": "Units: Count\n\nReporting Level: Application, Operator, Task, Parallelism",
3691
+ "stability": "experimental",
3692
+ "summary": "The total number of records this application, operator, or task has received."
3693
+ },
3694
+ "locationInModule": {
3695
+ "filename": "lib/application.ts",
3696
+ "line": 554
3697
+ },
3698
+ "name": "metricNumRecordsIn",
3699
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3700
+ "parameters": [
3701
+ {
3702
+ "name": "props",
3703
+ "optional": true,
3704
+ "type": {
3705
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3706
+ }
3707
+ }
3708
+ ],
3709
+ "returns": {
3710
+ "type": {
3711
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3712
+ }
3713
+ }
3714
+ },
3715
+ {
3716
+ "docs": {
3717
+ "default": "average over 5 minutes",
3718
+ "remarks": "Units: Count/Second\n\nReporting Level: Application, Operator, Task, Parallelism",
3719
+ "stability": "experimental",
3720
+ "summary": "The total number of records this application, operator or task has received per second."
3721
+ },
3722
+ "locationInModule": {
3723
+ "filename": "lib/application.ts",
3724
+ "line": 568
3725
+ },
3726
+ "name": "metricNumRecordsInPerSecond",
3727
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3728
+ "parameters": [
3729
+ {
3730
+ "name": "props",
3731
+ "optional": true,
3732
+ "type": {
3733
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3734
+ }
3735
+ }
3736
+ ],
3737
+ "returns": {
3738
+ "type": {
3739
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3740
+ }
3741
+ }
3742
+ },
3743
+ {
3744
+ "docs": {
3745
+ "default": "average over 5 minutes",
3746
+ "remarks": "Units: Count\n\nReporting Level: Application, Operator, Task, Parallelism",
3747
+ "stability": "experimental",
3748
+ "summary": "The total number of records this application, operator or task has emitted."
3749
+ },
3750
+ "locationInModule": {
3751
+ "filename": "lib/application.ts",
3752
+ "line": 581
3753
+ },
3754
+ "name": "metricNumRecordsOut",
3755
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3756
+ "parameters": [
3757
+ {
3758
+ "name": "props",
3759
+ "optional": true,
3760
+ "type": {
3761
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3762
+ }
3763
+ }
3764
+ ],
3765
+ "returns": {
3766
+ "type": {
3767
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3768
+ }
3769
+ }
3770
+ },
3771
+ {
3772
+ "docs": {
3773
+ "default": "average over 5 minutes",
3774
+ "remarks": "Units: Count/Second\n\nReporting Level: Application, Operator, Task, Parallelism",
3775
+ "stability": "experimental",
3776
+ "summary": "The total number of records this application, operator or task has emitted per second."
3777
+ },
3778
+ "locationInModule": {
3779
+ "filename": "lib/application.ts",
3780
+ "line": 595
3781
+ },
3782
+ "name": "metricNumRecordsOutPerSecond",
3783
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3784
+ "parameters": [
3785
+ {
3786
+ "name": "props",
3787
+ "optional": true,
3788
+ "type": {
3789
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3790
+ }
3791
+ }
3792
+ ],
3793
+ "returns": {
3794
+ "type": {
3795
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3796
+ }
3797
+ }
3798
+ },
3799
+ {
3800
+ "docs": {
3801
+ "default": "sum over 5 minutes",
3802
+ "remarks": "Units: Count\n\nReporting Level: Application",
3803
+ "stability": "experimental",
3804
+ "summary": "The total number of old garbage collection operations that have occurred across all task managers."
3805
+ },
3806
+ "locationInModule": {
3807
+ "filename": "lib/application.ts",
3808
+ "line": 527
3809
+ },
3810
+ "name": "metricOldGenerationGCCount",
3811
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3812
+ "parameters": [
3813
+ {
3814
+ "name": "props",
3815
+ "optional": true,
3816
+ "type": {
3817
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3818
+ }
3819
+ }
3820
+ ],
3821
+ "returns": {
3822
+ "type": {
3823
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3824
+ }
3825
+ }
3826
+ },
3827
+ {
3828
+ "docs": {
3829
+ "default": "sum over 5 minutes",
3830
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
3831
+ "stability": "experimental",
3832
+ "summary": "The total time spent performing old garbage collection operations."
3833
+ },
3834
+ "locationInModule": {
3835
+ "filename": "lib/application.ts",
3836
+ "line": 513
3837
+ },
3838
+ "name": "metricOldGenerationGCTime",
3839
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3840
+ "parameters": [
3841
+ {
3842
+ "name": "props",
3843
+ "optional": true,
3844
+ "type": {
3845
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3846
+ }
3847
+ }
3848
+ ],
3849
+ "returns": {
3850
+ "type": {
3851
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3852
+ }
3853
+ }
3854
+ },
3855
+ {
3856
+ "docs": {
3857
+ "default": "average over 5 minutes",
3858
+ "remarks": "Units: Count\n\nReporting Level: Application",
3859
+ "stability": "experimental",
3860
+ "summary": "The total number of live threads used by the application."
3861
+ },
3862
+ "locationInModule": {
3863
+ "filename": "lib/application.ts",
3864
+ "line": 540
3865
+ },
3866
+ "name": "metricThreadsCount",
3867
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3868
+ "parameters": [
3869
+ {
3870
+ "name": "props",
3871
+ "optional": true,
3872
+ "type": {
3873
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3874
+ }
3875
+ }
3876
+ ],
3877
+ "returns": {
3878
+ "type": {
3879
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3880
+ }
3881
+ }
3882
+ },
3883
+ {
3884
+ "docs": {
3885
+ "default": "average over 5 minutes",
3886
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
3887
+ "stability": "experimental",
3888
+ "summary": "The time that the job has been running without interruption."
3889
+ },
3890
+ "locationInModule": {
3891
+ "filename": "lib/application.ts",
3892
+ "line": 417
3893
+ },
3894
+ "name": "metricUptime",
3895
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3896
+ "parameters": [
3897
+ {
3898
+ "name": "props",
3899
+ "optional": true,
3900
+ "type": {
3901
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3902
+ }
3903
+ }
3904
+ ],
3905
+ "returns": {
3906
+ "type": {
3907
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3908
+ }
3909
+ }
3910
+ }
3911
+ ],
3912
+ "name": "Application",
3913
+ "properties": [
3914
+ {
3915
+ "docs": {
3916
+ "stability": "experimental",
3917
+ "summary": "The application ARN."
3918
+ },
3919
+ "immutable": true,
3920
+ "locationInModule": {
3921
+ "filename": "lib/application.ts",
3922
+ "line": 896
3923
+ },
3924
+ "name": "applicationArn",
3925
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3926
+ "type": {
3927
+ "primitive": "string"
3928
+ }
3929
+ },
3930
+ {
3931
+ "docs": {
3932
+ "stability": "experimental",
3933
+ "summary": "The name of the Flink application."
3934
+ },
3935
+ "immutable": true,
3936
+ "locationInModule": {
3937
+ "filename": "lib/application.ts",
3938
+ "line": 897
3939
+ },
3940
+ "name": "applicationName",
3941
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3942
+ "type": {
3943
+ "primitive": "string"
3944
+ }
3945
+ },
3946
+ {
3947
+ "docs": {
3948
+ "stability": "experimental",
3949
+ "summary": "The principal to grant permissions to."
3950
+ },
3951
+ "immutable": true,
3952
+ "locationInModule": {
3953
+ "filename": "lib/application.ts",
3954
+ "line": 902
3955
+ },
3956
+ "name": "grantPrincipal",
3957
+ "overrides": "aws-cdk-lib.aws_iam.IGrantable",
3958
+ "type": {
3959
+ "fqn": "aws-cdk-lib.aws_iam.IPrincipal"
3960
+ }
3961
+ },
3962
+ {
3963
+ "docs": {
3964
+ "stability": "experimental",
3965
+ "summary": "The application IAM role."
3966
+ },
3967
+ "immutable": true,
3968
+ "locationInModule": {
3969
+ "filename": "lib/application.ts",
3970
+ "line": 900
3971
+ },
3972
+ "name": "role",
3973
+ "optional": true,
3974
+ "overrides": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3975
+ "type": {
3976
+ "fqn": "aws-cdk-lib.aws_iam.IRole"
3977
+ }
3978
+ }
3979
+ ],
3980
+ "symbolId": "lib/application:Application"
3981
+ },
3982
+ "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode": {
3983
+ "abstract": true,
3984
+ "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
3985
+ "docs": {
3986
+ "custom": {
3987
+ "exampleMetadata": "lit=test/integ.application.lit.ts ! show infused"
3988
+ },
3989
+ "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nconst flinkApp = new flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n\nnew cloudwatch.Alarm(stack, 'Alarm', {\n metric: flinkApp.metricFullRestarts(),\n evaluationPeriods: 1,\n threshold: 3,\n});\n///! hide\n\napp.synth();",
3990
+ "stability": "experimental",
3991
+ "summary": "Code configuration providing the location to a Flink application JAR file."
3992
+ },
3993
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode",
3994
+ "initializer": {
3995
+ "docs": {
3996
+ "stability": "experimental"
3997
+ }
3998
+ },
3999
+ "kind": "class",
4000
+ "locationInModule": {
4001
+ "filename": "lib/application-code.ts",
4002
+ "line": 26
4003
+ },
4004
+ "methods": [
4005
+ {
4006
+ "docs": {
4007
+ "custom": {
4008
+ "parm": "options - standard s3 AssetOptions"
4009
+ },
4010
+ "stability": "experimental",
4011
+ "summary": "Reference code from a local directory containing a Flink JAR file."
4012
+ },
4013
+ "locationInModule": {
4014
+ "filename": "lib/application-code.ts",
4015
+ "line": 48
4016
+ },
4017
+ "name": "fromAsset",
4018
+ "parameters": [
4019
+ {
4020
+ "docs": {
4021
+ "summary": "- a local directory path."
4022
+ },
4023
+ "name": "path",
4024
+ "type": {
4025
+ "primitive": "string"
4026
+ }
4027
+ },
4028
+ {
4029
+ "name": "options",
4030
+ "optional": true,
4031
+ "type": {
4032
+ "fqn": "aws-cdk-lib.aws_s3_assets.AssetOptions"
4033
+ }
4034
+ }
4035
+ ],
4036
+ "returns": {
4037
+ "type": {
4038
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode"
4039
+ }
4040
+ },
4041
+ "static": true
4042
+ },
4043
+ {
4044
+ "docs": {
4045
+ "stability": "experimental",
4046
+ "summary": "Reference code from an S3 bucket."
4047
+ },
4048
+ "locationInModule": {
4049
+ "filename": "lib/application-code.ts",
4050
+ "line": 34
4051
+ },
4052
+ "name": "fromBucket",
4053
+ "parameters": [
4054
+ {
4055
+ "docs": {
4056
+ "summary": "- an s3 bucket."
4057
+ },
4058
+ "name": "bucket",
4059
+ "type": {
4060
+ "fqn": "aws-cdk-lib.aws_s3.IBucket"
4061
+ }
4062
+ },
4063
+ {
4064
+ "docs": {
4065
+ "summary": "- a key pointing to a Flink JAR file."
4066
+ },
4067
+ "name": "fileKey",
4068
+ "type": {
4069
+ "primitive": "string"
4070
+ }
4071
+ },
4072
+ {
4073
+ "docs": {
4074
+ "summary": "- an optional version string for the provided fileKey."
4075
+ },
4076
+ "name": "objectVersion",
4077
+ "optional": true,
4078
+ "type": {
4079
+ "primitive": "string"
4080
+ }
4081
+ }
4082
+ ],
4083
+ "returns": {
4084
+ "type": {
4085
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode"
4086
+ }
4087
+ },
4088
+ "static": true
4089
+ },
4090
+ {
4091
+ "abstract": true,
4092
+ "docs": {
4093
+ "stability": "experimental",
4094
+ "summary": "A method to lazily bind asset resources to the parent FlinkApplication."
4095
+ },
4096
+ "locationInModule": {
4097
+ "filename": "lib/application-code.ts",
4098
+ "line": 55
4099
+ },
4100
+ "name": "bind",
4101
+ "parameters": [
4102
+ {
4103
+ "name": "scope",
4104
+ "type": {
4105
+ "fqn": "constructs.Construct"
4106
+ }
4107
+ }
4108
+ ],
4109
+ "returns": {
4110
+ "type": {
4111
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCodeConfig"
4112
+ }
4113
+ }
4114
+ }
4115
+ ],
4116
+ "name": "ApplicationCode",
4117
+ "symbolId": "lib/application-code:ApplicationCode"
4118
+ },
4119
+ "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCodeConfig": {
4120
+ "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
4121
+ "datatype": true,
4122
+ "docs": {
4123
+ "stability": "experimental",
4124
+ "summary": "The return type of {@link ApplicationCode.bind}. This represents CloudFormation configuration and an s3 bucket holding the Flink application JAR file.",
4125
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kinesisanalytics_flink_alpha from '@aws-cdk/aws-kinesisanalytics-flink-alpha';\nimport { aws_s3 as s3 } from 'aws-cdk-lib';\n\ndeclare const bucket: s3.Bucket;\ndeclare const propertyMap: any;\nconst applicationCodeConfig: kinesisanalytics_flink_alpha.ApplicationCodeConfig = {\n applicationCodeConfigurationProperty: {\n applicationCodeConfiguration: {\n codeContent: {\n s3ContentLocation: {\n bucketArn: 'bucketArn',\n fileKey: 'fileKey',\n objectVersion: 'objectVersion',\n },\n textContent: 'textContent',\n zipFileContent: 'zipFileContent',\n },\n codeContentType: 'codeContentType',\n },\n applicationSnapshotConfiguration: {\n snapshotsEnabled: false,\n },\n environmentProperties: {\n propertyGroups: [{\n propertyGroupId: 'propertyGroupId',\n propertyMap: propertyMap,\n }],\n },\n flinkApplicationConfiguration: {\n checkpointConfiguration: {\n configurationType: 'configurationType',\n\n // the properties below are optional\n checkpointingEnabled: false,\n checkpointInterval: 123,\n minPauseBetweenCheckpoints: 123,\n },\n monitoringConfiguration: {\n configurationType: 'configurationType',\n\n // the properties below are optional\n logLevel: 'logLevel',\n metricsLevel: 'metricsLevel',\n },\n parallelismConfiguration: {\n configurationType: 'configurationType',\n\n // the properties below are optional\n autoScalingEnabled: false,\n parallelism: 123,\n parallelismPerKpu: 123,\n },\n },\n sqlApplicationConfiguration: {\n inputs: [{\n inputSchema: {\n recordColumns: [{\n name: 'name',\n sqlType: 'sqlType',\n\n // the properties below are optional\n mapping: 'mapping',\n }],\n recordFormat: {\n recordFormatType: 'recordFormatType',\n\n // the properties below are optional\n mappingParameters: {\n csvMappingParameters: {\n recordColumnDelimiter: 'recordColumnDelimiter',\n recordRowDelimiter: 'recordRowDelimiter',\n },\n jsonMappingParameters: {\n recordRowPath: 'recordRowPath',\n },\n },\n },\n\n // the properties below are optional\n recordEncoding: 'recordEncoding',\n },\n namePrefix: 'namePrefix',\n\n // the properties below are optional\n inputParallelism: {\n count: 123,\n },\n inputProcessingConfiguration: {\n inputLambdaProcessor: {\n resourceArn: 'resourceArn',\n },\n },\n kinesisFirehoseInput: {\n resourceArn: 'resourceArn',\n },\n kinesisStreamsInput: {\n resourceArn: 'resourceArn',\n },\n }],\n },\n zeppelinApplicationConfiguration: {\n catalogConfiguration: {\n glueDataCatalogConfiguration: {\n databaseArn: 'databaseArn',\n },\n },\n customArtifactsConfiguration: [{\n artifactType: 'artifactType',\n\n // the properties below are optional\n mavenReference: {\n artifactId: 'artifactId',\n groupId: 'groupId',\n version: 'version',\n },\n s3ContentLocation: {\n bucketArn: 'bucketArn',\n fileKey: 'fileKey',\n objectVersion: 'objectVersion',\n },\n }],\n deployAsApplicationConfiguration: {\n s3ContentLocation: {\n basePath: 'basePath',\n bucketArn: 'bucketArn',\n },\n },\n monitoringConfiguration: {\n logLevel: 'logLevel',\n },\n },\n },\n bucket: bucket,\n};",
4126
+ "custom": {
4127
+ "exampleMetadata": "fixture=_generated"
4128
+ }
4129
+ },
4130
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCodeConfig",
4131
+ "kind": "interface",
4132
+ "locationInModule": {
4133
+ "filename": "lib/application-code.ts",
4134
+ "line": 11
4135
+ },
4136
+ "name": "ApplicationCodeConfig",
4137
+ "properties": [
4138
+ {
4139
+ "abstract": true,
4140
+ "docs": {
4141
+ "stability": "experimental",
4142
+ "summary": "Low-level Cloudformation ApplicationConfigurationProperty."
4143
+ },
4144
+ "immutable": true,
4145
+ "locationInModule": {
4146
+ "filename": "lib/application-code.ts",
4147
+ "line": 15
4148
+ },
4149
+ "name": "applicationCodeConfigurationProperty",
4150
+ "type": {
4151
+ "fqn": "aws-cdk-lib.aws_kinesisanalytics.CfnApplicationV2.ApplicationConfigurationProperty"
4152
+ }
4153
+ },
4154
+ {
4155
+ "abstract": true,
4156
+ "docs": {
4157
+ "stability": "experimental",
4158
+ "summary": "S3 Bucket that stores the Flink application code."
4159
+ },
4160
+ "immutable": true,
4161
+ "locationInModule": {
4162
+ "filename": "lib/application-code.ts",
4163
+ "line": 20
4164
+ },
4165
+ "name": "bucket",
4166
+ "type": {
3403
4167
  "fqn": "aws-cdk-lib.aws_s3.IBucket"
3404
4168
  }
3405
- }
3406
- ],
3407
- "symbolId": "lib/application-code:ApplicationCodeConfig"
3408
- },
3409
- "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationProps": {
3410
- "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
3411
- "datatype": true,
3412
- "docs": {
3413
- "custom": {
3414
- "exampleMetadata": "lit=test/integ.application.lit.ts ! show infused"
4169
+ }
4170
+ ],
4171
+ "symbolId": "lib/application-code:ApplicationCodeConfig"
4172
+ },
4173
+ "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationProps": {
4174
+ "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
4175
+ "datatype": true,
4176
+ "docs": {
4177
+ "custom": {
4178
+ "exampleMetadata": "lit=test/integ.application.lit.ts ! show infused"
4179
+ },
4180
+ "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nconst flinkApp = new flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n\nnew cloudwatch.Alarm(stack, 'Alarm', {\n metric: flinkApp.metricFullRestarts(),\n evaluationPeriods: 1,\n threshold: 3,\n});\n///! hide\n\napp.synth();",
4181
+ "stability": "experimental",
4182
+ "summary": "Props for creating an Application construct."
4183
+ },
4184
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationProps",
4185
+ "kind": "interface",
4186
+ "locationInModule": {
4187
+ "filename": "lib/application.ts",
4188
+ "line": 726
4189
+ },
4190
+ "name": "ApplicationProps",
4191
+ "properties": [
4192
+ {
4193
+ "abstract": true,
4194
+ "docs": {
4195
+ "stability": "experimental",
4196
+ "summary": "The Flink code asset to run."
4197
+ },
4198
+ "immutable": true,
4199
+ "locationInModule": {
4200
+ "filename": "lib/application.ts",
4201
+ "line": 742
4202
+ },
4203
+ "name": "code",
4204
+ "type": {
4205
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode"
4206
+ }
4207
+ },
4208
+ {
4209
+ "abstract": true,
4210
+ "docs": {
4211
+ "stability": "experimental",
4212
+ "summary": "The Flink version to use for this application."
4213
+ },
4214
+ "immutable": true,
4215
+ "locationInModule": {
4216
+ "filename": "lib/application.ts",
4217
+ "line": 737
4218
+ },
4219
+ "name": "runtime",
4220
+ "type": {
4221
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.Runtime"
4222
+ }
4223
+ },
4224
+ {
4225
+ "abstract": true,
4226
+ "docs": {
4227
+ "default": "- CloudFormation-generated name",
4228
+ "stability": "experimental",
4229
+ "summary": "A name for your Application that is unique to an AWS account."
4230
+ },
4231
+ "immutable": true,
4232
+ "locationInModule": {
4233
+ "filename": "lib/application.ts",
4234
+ "line": 732
4235
+ },
4236
+ "name": "applicationName",
4237
+ "optional": true,
4238
+ "type": {
4239
+ "primitive": "string"
4240
+ }
4241
+ },
4242
+ {
4243
+ "abstract": true,
4244
+ "docs": {
4245
+ "default": "true",
4246
+ "stability": "experimental",
4247
+ "summary": "Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage."
4248
+ },
4249
+ "immutable": true,
4250
+ "locationInModule": {
4251
+ "filename": "lib/application.ts",
4252
+ "line": 789
4253
+ },
4254
+ "name": "autoScalingEnabled",
4255
+ "optional": true,
4256
+ "type": {
4257
+ "primitive": "boolean"
4258
+ }
4259
+ },
4260
+ {
4261
+ "abstract": true,
4262
+ "docs": {
4263
+ "default": "true",
4264
+ "stability": "experimental",
4265
+ "summary": "Whether checkpointing is enabled while your application runs."
4266
+ },
4267
+ "immutable": true,
4268
+ "locationInModule": {
4269
+ "filename": "lib/application.ts",
4270
+ "line": 749
4271
+ },
4272
+ "name": "checkpointingEnabled",
4273
+ "optional": true,
4274
+ "type": {
4275
+ "primitive": "boolean"
4276
+ }
4277
+ },
4278
+ {
4279
+ "abstract": true,
4280
+ "docs": {
4281
+ "default": "1 minute",
4282
+ "stability": "experimental",
4283
+ "summary": "The interval between checkpoints."
4284
+ },
4285
+ "immutable": true,
4286
+ "locationInModule": {
4287
+ "filename": "lib/application.ts",
4288
+ "line": 756
4289
+ },
4290
+ "name": "checkpointInterval",
4291
+ "optional": true,
4292
+ "type": {
4293
+ "fqn": "aws-cdk-lib.Duration"
4294
+ }
4295
+ },
4296
+ {
4297
+ "abstract": true,
4298
+ "docs": {
4299
+ "default": "CDK's default LogGroup",
4300
+ "stability": "experimental",
4301
+ "summary": "The log group to send log entries to."
4302
+ },
4303
+ "immutable": true,
4304
+ "locationInModule": {
4305
+ "filename": "lib/application.ts",
4306
+ "line": 842
4307
+ },
4308
+ "name": "logGroup",
4309
+ "optional": true,
4310
+ "type": {
4311
+ "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
4312
+ }
4313
+ },
4314
+ {
4315
+ "abstract": true,
4316
+ "docs": {
4317
+ "default": "FlinkLogLevel.INFO",
4318
+ "stability": "experimental",
4319
+ "summary": "The level of log verbosity from the Flink application."
4320
+ },
4321
+ "immutable": true,
4322
+ "locationInModule": {
4323
+ "filename": "lib/application.ts",
4324
+ "line": 771
4325
+ },
4326
+ "name": "logLevel",
4327
+ "optional": true,
4328
+ "type": {
4329
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.LogLevel"
4330
+ }
4331
+ },
4332
+ {
4333
+ "abstract": true,
4334
+ "docs": {
4335
+ "default": "MetricsLevel.APPLICATION",
4336
+ "remarks": "Use caution with Parallelism level metrics. Parallelism granularity logs\nmetrics for each parallel thread and can quickly become expensive when\nparallelism is high (e.g. > 64).",
4337
+ "stability": "experimental",
4338
+ "summary": "Describes the granularity of the CloudWatch metrics for an application."
4339
+ },
4340
+ "immutable": true,
4341
+ "locationInModule": {
4342
+ "filename": "lib/application.ts",
4343
+ "line": 781
4344
+ },
4345
+ "name": "metricsLevel",
4346
+ "optional": true,
4347
+ "type": {
4348
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.MetricsLevel"
4349
+ }
4350
+ },
4351
+ {
4352
+ "abstract": true,
4353
+ "docs": {
4354
+ "default": "5 seconds",
4355
+ "stability": "experimental",
4356
+ "summary": "The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint."
4357
+ },
4358
+ "immutable": true,
4359
+ "locationInModule": {
4360
+ "filename": "lib/application.ts",
4361
+ "line": 764
4362
+ },
4363
+ "name": "minPauseBetweenCheckpoints",
4364
+ "optional": true,
4365
+ "type": {
4366
+ "fqn": "aws-cdk-lib.Duration"
4367
+ }
4368
+ },
4369
+ {
4370
+ "abstract": true,
4371
+ "docs": {
4372
+ "default": "1",
4373
+ "remarks": "Kinesis Data Analytics can\nstop the app, increase the parallelism, and start the app again if\nautoScalingEnabled is true (the default value).",
4374
+ "stability": "experimental",
4375
+ "summary": "The initial parallelism for the application."
4376
+ },
4377
+ "immutable": true,
4378
+ "locationInModule": {
4379
+ "filename": "lib/application.ts",
4380
+ "line": 798
4381
+ },
4382
+ "name": "parallelism",
4383
+ "optional": true,
4384
+ "type": {
4385
+ "primitive": "number"
4386
+ }
4387
+ },
4388
+ {
4389
+ "abstract": true,
4390
+ "docs": {
4391
+ "default": "1",
4392
+ "stability": "experimental",
4393
+ "summary": "The Flink parallelism allowed per Kinesis Processing Unit (KPU)."
4394
+ },
4395
+ "immutable": true,
4396
+ "locationInModule": {
4397
+ "filename": "lib/application.ts",
4398
+ "line": 805
4399
+ },
4400
+ "name": "parallelismPerKpu",
4401
+ "optional": true,
4402
+ "type": {
4403
+ "primitive": "number"
4404
+ }
4405
+ },
4406
+ {
4407
+ "abstract": true,
4408
+ "docs": {
4409
+ "default": "No property group configuration provided to the Flink app",
4410
+ "remarks": "You can use these property groups to pass\narbitrary runtime configuration values to your Flink app.",
4411
+ "stability": "experimental",
4412
+ "summary": "Configuration PropertyGroups."
4413
+ },
4414
+ "immutable": true,
4415
+ "locationInModule": {
4416
+ "filename": "lib/application.ts",
4417
+ "line": 820
4418
+ },
4419
+ "name": "propertyGroups",
4420
+ "optional": true,
4421
+ "type": {
4422
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.PropertyGroups"
4423
+ }
4424
+ },
4425
+ {
4426
+ "abstract": true,
4427
+ "docs": {
4428
+ "default": "RemovalPolicy.DESTROY",
4429
+ "stability": "experimental",
4430
+ "summary": "Provide a RemovalPolicy to override the default."
4431
+ },
4432
+ "immutable": true,
4433
+ "locationInModule": {
4434
+ "filename": "lib/application.ts",
4435
+ "line": 835
4436
+ },
4437
+ "name": "removalPolicy",
4438
+ "optional": true,
4439
+ "type": {
4440
+ "fqn": "aws-cdk-lib.RemovalPolicy"
4441
+ }
4442
+ },
4443
+ {
4444
+ "abstract": true,
4445
+ "docs": {
4446
+ "default": "- a new Role will be created",
4447
+ "remarks": "Prefer omitting\nthis property and using the default role.",
4448
+ "stability": "experimental",
4449
+ "summary": "A role to use to grant permissions to your application."
4450
+ },
4451
+ "immutable": true,
4452
+ "locationInModule": {
4453
+ "filename": "lib/application.ts",
4454
+ "line": 828
4455
+ },
4456
+ "name": "role",
4457
+ "optional": true,
4458
+ "type": {
4459
+ "fqn": "aws-cdk-lib.aws_iam.IRole"
4460
+ }
4461
+ },
4462
+ {
4463
+ "abstract": true,
4464
+ "docs": {
4465
+ "default": "true",
4466
+ "stability": "experimental",
4467
+ "summary": "Determines if Flink snapshots are enabled."
4468
+ },
4469
+ "immutable": true,
4470
+ "locationInModule": {
4471
+ "filename": "lib/application.ts",
4472
+ "line": 812
4473
+ },
4474
+ "name": "snapshotsEnabled",
4475
+ "optional": true,
4476
+ "type": {
4477
+ "primitive": "boolean"
4478
+ }
4479
+ }
4480
+ ],
4481
+ "symbolId": "lib/application:ApplicationProps"
4482
+ },
4483
+ "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication": {
4484
+ "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
4485
+ "docs": {
4486
+ "stability": "experimental",
4487
+ "summary": "An interface expressing the public properties on both an imported and CDK-created Flink application."
4488
+ },
4489
+ "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
4490
+ "interfaces": [
4491
+ "aws-cdk-lib.IResource",
4492
+ "aws-cdk-lib.aws_iam.IGrantable"
4493
+ ],
4494
+ "kind": "interface",
4495
+ "locationInModule": {
4496
+ "filename": "lib/application.ts",
4497
+ "line": 17
4498
+ },
4499
+ "methods": [
4500
+ {
4501
+ "abstract": true,
4502
+ "docs": {
4503
+ "stability": "experimental",
4504
+ "summary": "Convenience method for adding a policy statement to the application role."
4505
+ },
4506
+ "locationInModule": {
4507
+ "filename": "lib/application.ts",
4508
+ "line": 40
4509
+ },
4510
+ "name": "addToRolePolicy",
4511
+ "parameters": [
4512
+ {
4513
+ "name": "policyStatement",
4514
+ "type": {
4515
+ "fqn": "aws-cdk-lib.aws_iam.PolicyStatement"
4516
+ }
4517
+ }
4518
+ ],
4519
+ "returns": {
4520
+ "type": {
4521
+ "primitive": "boolean"
4522
+ }
4523
+ }
4524
+ },
4525
+ {
4526
+ "abstract": true,
4527
+ "docs": {
4528
+ "stability": "experimental",
4529
+ "summary": "Return a CloudWatch metric associated with this Flink application."
4530
+ },
4531
+ "locationInModule": {
4532
+ "filename": "lib/application.ts",
4533
+ "line": 48
4534
+ },
4535
+ "name": "metric",
4536
+ "parameters": [
4537
+ {
4538
+ "docs": {
4539
+ "summary": "The name of the metric."
4540
+ },
4541
+ "name": "metricName",
4542
+ "type": {
4543
+ "primitive": "string"
4544
+ }
4545
+ },
4546
+ {
4547
+ "docs": {
4548
+ "summary": "Customization properties."
4549
+ },
4550
+ "name": "props",
4551
+ "optional": true,
4552
+ "type": {
4553
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4554
+ }
4555
+ }
4556
+ ],
4557
+ "returns": {
4558
+ "type": {
4559
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4560
+ }
4561
+ }
3415
4562
  },
3416
- "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nnew flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n///! hide\n\napp.synth();",
3417
- "stability": "experimental",
3418
- "summary": "Props for creating an Application construct."
3419
- },
3420
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationProps",
3421
- "kind": "interface",
3422
- "locationInModule": {
3423
- "filename": "lib/application.ts",
3424
- "line": 68
3425
- },
3426
- "name": "ApplicationProps",
3427
- "properties": [
3428
4563
  {
3429
4564
  "abstract": true,
3430
4565
  "docs": {
4566
+ "default": "average over 5 minutes",
4567
+ "remarks": "Units: Milliseconds\n\nReporting Level: Operator, Task, Parallelism",
3431
4568
  "stability": "experimental",
3432
- "summary": "The Flink code asset to run."
4569
+ "summary": "The time (in milliseconds) this task or operator is back pressured per second."
3433
4570
  },
3434
- "immutable": true,
3435
4571
  "locationInModule": {
3436
4572
  "filename": "lib/application.ts",
3437
- "line": 84
4573
+ "line": 326
3438
4574
  },
3439
- "name": "code",
3440
- "type": {
3441
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.ApplicationCode"
4575
+ "name": "metricBackPressuredTimeMsPerSecond",
4576
+ "parameters": [
4577
+ {
4578
+ "name": "props",
4579
+ "optional": true,
4580
+ "type": {
4581
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4582
+ }
4583
+ }
4584
+ ],
4585
+ "returns": {
4586
+ "type": {
4587
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4588
+ }
3442
4589
  }
3443
4590
  },
3444
4591
  {
3445
4592
  "abstract": true,
3446
4593
  "docs": {
4594
+ "default": "average over 5 minutes",
4595
+ "remarks": "Can be NaN, if the value could not be\ncalculated.\n\nUnits: Milliseconds\n\nReporting Level: Operator, Task, Parallelism",
3447
4596
  "stability": "experimental",
3448
- "summary": "The Flink version to use for this application."
4597
+ "summary": "The time (in milliseconds) this task or operator is busy (neither idle nor back pressured) per second."
3449
4598
  },
3450
- "immutable": true,
3451
4599
  "locationInModule": {
3452
4600
  "filename": "lib/application.ts",
3453
- "line": 79
4601
+ "line": 339
3454
4602
  },
3455
- "name": "runtime",
3456
- "type": {
3457
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.Runtime"
4603
+ "name": "metricBusyTimePerMsPerSecond",
4604
+ "parameters": [
4605
+ {
4606
+ "name": "props",
4607
+ "optional": true,
4608
+ "type": {
4609
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4610
+ }
4611
+ }
4612
+ ],
4613
+ "returns": {
4614
+ "type": {
4615
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4616
+ }
3458
4617
  }
3459
4618
  },
3460
4619
  {
3461
4620
  "abstract": true,
3462
4621
  "docs": {
3463
- "default": "- CloudFormation-generated name",
4622
+ "default": "average over 5 minutes",
4623
+ "remarks": "For\nexample, if there are five task managers, Kinesis Data Analytics publishes\nfive samples of this metric per reporting interval.\n\nUnits: Percentage\n\nReporting Level: Application",
3464
4624
  "stability": "experimental",
3465
- "summary": "A name for your Application that is unique to an AWS account."
4625
+ "summary": "The overall percentage of CPU utilization across task managers."
3466
4626
  },
3467
- "immutable": true,
3468
4627
  "locationInModule": {
3469
4628
  "filename": "lib/application.ts",
3470
- "line": 74
4629
+ "line": 141
3471
4630
  },
3472
- "name": "applicationName",
3473
- "optional": true,
3474
- "type": {
3475
- "primitive": "string"
4631
+ "name": "metricCpuUtilization",
4632
+ "parameters": [
4633
+ {
4634
+ "name": "props",
4635
+ "optional": true,
4636
+ "type": {
4637
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4638
+ }
4639
+ }
4640
+ ],
4641
+ "returns": {
4642
+ "type": {
4643
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4644
+ }
4645
+ }
4646
+ },
4647
+ {
4648
+ "abstract": true,
4649
+ "docs": {
4650
+ "default": "maximum over 5 minutes",
4651
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application, Operator, Task, Parallelism",
4652
+ "stability": "experimental",
4653
+ "summary": "The last watermark this application/operator/task/thread has received."
4654
+ },
4655
+ "locationInModule": {
4656
+ "filename": "lib/application.ts",
4657
+ "line": 257
4658
+ },
4659
+ "name": "metricCurrentInputWatermark",
4660
+ "parameters": [
4661
+ {
4662
+ "name": "props",
4663
+ "optional": true,
4664
+ "type": {
4665
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4666
+ }
4667
+ }
4668
+ ],
4669
+ "returns": {
4670
+ "type": {
4671
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4672
+ }
4673
+ }
4674
+ },
4675
+ {
4676
+ "abstract": true,
4677
+ "docs": {
4678
+ "default": "maximum over 5 minutes",
4679
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application, Operator, Task, Parallelism",
4680
+ "stability": "experimental",
4681
+ "summary": "The last watermark this application/operator/task/thread has received."
4682
+ },
4683
+ "locationInModule": {
4684
+ "filename": "lib/application.ts",
4685
+ "line": 268
4686
+ },
4687
+ "name": "metricCurrentOutputWatermark",
4688
+ "parameters": [
4689
+ {
4690
+ "name": "props",
4691
+ "optional": true,
4692
+ "type": {
4693
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4694
+ }
4695
+ }
4696
+ ],
4697
+ "returns": {
4698
+ "type": {
4699
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4700
+ }
4701
+ }
4702
+ },
4703
+ {
4704
+ "abstract": true,
4705
+ "docs": {
4706
+ "default": "average over 5 minutes",
4707
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
4708
+ "stability": "experimental",
4709
+ "summary": "The time elapsed during an outage for failing/recovering jobs."
4710
+ },
4711
+ "locationInModule": {
4712
+ "filename": "lib/application.ts",
4713
+ "line": 72
4714
+ },
4715
+ "name": "metricDowntime",
4716
+ "parameters": [
4717
+ {
4718
+ "name": "props",
4719
+ "optional": true,
4720
+ "type": {
4721
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4722
+ }
4723
+ }
4724
+ ],
4725
+ "returns": {
4726
+ "type": {
4727
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4728
+ }
4729
+ }
4730
+ },
4731
+ {
4732
+ "abstract": true,
4733
+ "docs": {
4734
+ "default": "sum over 5 minutes",
4735
+ "remarks": "This metric does not measure fine-grained restarts.\n\nUnits: Count\n\nReporting Level: Application",
4736
+ "stability": "experimental",
4737
+ "summary": "The total number of times this job has fully restarted since it was submitted."
4738
+ },
4739
+ "locationInModule": {
4740
+ "filename": "lib/application.ts",
4741
+ "line": 95
4742
+ },
4743
+ "name": "metricFullRestarts",
4744
+ "parameters": [
4745
+ {
4746
+ "name": "props",
4747
+ "optional": true,
4748
+ "type": {
4749
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4750
+ }
4751
+ }
4752
+ ],
4753
+ "returns": {
4754
+ "type": {
4755
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4756
+ }
4757
+ }
4758
+ },
4759
+ {
4760
+ "abstract": true,
4761
+ "docs": {
4762
+ "default": "average over 5 minutes",
4763
+ "remarks": "For example, if there\nare five task managers, Kinesis Data Analytics publishes five samples of\nthis metric per reporting interval.\n\nUnits: Percentage\n\nReporting Level: Application",
4764
+ "stability": "experimental",
4765
+ "summary": "Overall heap memory utilization across task managers."
4766
+ },
4767
+ "locationInModule": {
4768
+ "filename": "lib/application.ts",
4769
+ "line": 154
4770
+ },
4771
+ "name": "metricHeapMemoryUtilization",
4772
+ "parameters": [
4773
+ {
4774
+ "name": "props",
4775
+ "optional": true,
4776
+ "type": {
4777
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4778
+ }
4779
+ }
4780
+ ],
4781
+ "returns": {
4782
+ "type": {
4783
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4784
+ }
4785
+ }
4786
+ },
4787
+ {
4788
+ "abstract": true,
4789
+ "docs": {
4790
+ "default": "average over 5 minutes",
4791
+ "remarks": "Idle time excludes back pressured time, so if the task\nis back pressured it is not idle.\n\nUnits: Milliseconds\n\nReporting Level: Operator, Task, Parallelism",
4792
+ "stability": "experimental",
4793
+ "summary": "The time (in milliseconds) this task or operator is idle (has no data to process) per second."
4794
+ },
4795
+ "locationInModule": {
4796
+ "filename": "lib/application.ts",
4797
+ "line": 314
4798
+ },
4799
+ "name": "metricIdleTimeMsPerSecond",
4800
+ "parameters": [
4801
+ {
4802
+ "name": "props",
4803
+ "optional": true,
4804
+ "type": {
4805
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4806
+ }
4807
+ }
4808
+ ],
4809
+ "returns": {
4810
+ "type": {
4811
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4812
+ }
4813
+ }
4814
+ },
4815
+ {
4816
+ "abstract": true,
4817
+ "docs": {
4818
+ "default": "average over 5 minutes",
4819
+ "remarks": "The average number of KPUs used each hour\ndetermines the billing for your application.\n\nUnits: Count\n\nReporting Level: Application",
4820
+ "stability": "experimental",
4821
+ "summary": "The number of Kinesis Processing Units that are used to run your stream processing application."
4822
+ },
4823
+ "locationInModule": {
4824
+ "filename": "lib/application.ts",
4825
+ "line": 61
4826
+ },
4827
+ "name": "metricKpus",
4828
+ "parameters": [
4829
+ {
4830
+ "name": "props",
4831
+ "optional": true,
4832
+ "type": {
4833
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4834
+ }
4835
+ }
4836
+ ],
4837
+ "returns": {
4838
+ "type": {
4839
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4840
+ }
4841
+ }
4842
+ },
4843
+ {
4844
+ "abstract": true,
4845
+ "docs": {
4846
+ "default": "maximum over 5 minutes",
4847
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
4848
+ "stability": "experimental",
4849
+ "summary": "The time it took to complete the last checkpoint."
4850
+ },
4851
+ "locationInModule": {
4852
+ "filename": "lib/application.ts",
4853
+ "line": 117
4854
+ },
4855
+ "name": "metricLastCheckpointDuration",
4856
+ "parameters": [
4857
+ {
4858
+ "name": "props",
4859
+ "optional": true,
4860
+ "type": {
4861
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4862
+ }
4863
+ }
4864
+ ],
4865
+ "returns": {
4866
+ "type": {
4867
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4868
+ }
3476
4869
  }
3477
4870
  },
3478
4871
  {
3479
4872
  "abstract": true,
3480
4873
  "docs": {
3481
- "default": "true",
4874
+ "default": "maximum over 5 minutes",
4875
+ "remarks": "Units: Bytes\n\nReporting Level: Application",
3482
4876
  "stability": "experimental",
3483
- "summary": "Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage."
4877
+ "summary": "The total size of the last checkpoint."
3484
4878
  },
3485
- "immutable": true,
3486
4879
  "locationInModule": {
3487
4880
  "filename": "lib/application.ts",
3488
- "line": 131
4881
+ "line": 128
3489
4882
  },
3490
- "name": "autoScalingEnabled",
3491
- "optional": true,
3492
- "type": {
3493
- "primitive": "boolean"
4883
+ "name": "metricLastCheckpointSize",
4884
+ "parameters": [
4885
+ {
4886
+ "name": "props",
4887
+ "optional": true,
4888
+ "type": {
4889
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4890
+ }
4891
+ }
4892
+ ],
4893
+ "returns": {
4894
+ "type": {
4895
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4896
+ }
3494
4897
  }
3495
4898
  },
3496
4899
  {
3497
4900
  "abstract": true,
3498
4901
  "docs": {
3499
- "default": "true",
4902
+ "default": "average over 5 minutes",
4903
+ "remarks": "Units: Bytes\n\nReporting Level: Application, Operator, Task, Parallelism",
3500
4904
  "stability": "experimental",
3501
- "summary": "Whether checkpointing is enabled while your application runs."
4905
+ "summary": "The total amount of managed memory."
3502
4906
  },
3503
- "immutable": true,
3504
4907
  "locationInModule": {
3505
4908
  "filename": "lib/application.ts",
3506
- "line": 91
4909
+ "line": 290
3507
4910
  },
3508
- "name": "checkpointingEnabled",
3509
- "optional": true,
3510
- "type": {
3511
- "primitive": "boolean"
4911
+ "name": "metricManagedMemoryTotal",
4912
+ "parameters": [
4913
+ {
4914
+ "name": "props",
4915
+ "optional": true,
4916
+ "type": {
4917
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4918
+ }
4919
+ }
4920
+ ],
4921
+ "returns": {
4922
+ "type": {
4923
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4924
+ }
3512
4925
  }
3513
4926
  },
3514
4927
  {
3515
4928
  "abstract": true,
3516
4929
  "docs": {
3517
- "default": "1 minute",
4930
+ "default": "average over 5 minutes",
4931
+ "remarks": "Units: Bytes\n\nReporting Level: Application, Operator, Task, Parallelism",
3518
4932
  "stability": "experimental",
3519
- "summary": "The interval between checkpoints."
4933
+ "summary": "The amount of managed memory currently used."
3520
4934
  },
3521
- "immutable": true,
3522
4935
  "locationInModule": {
3523
4936
  "filename": "lib/application.ts",
3524
- "line": 98
4937
+ "line": 279
3525
4938
  },
3526
- "name": "checkpointInterval",
3527
- "optional": true,
3528
- "type": {
3529
- "fqn": "aws-cdk-lib.Duration"
4939
+ "name": "metricManagedMemoryUsed",
4940
+ "parameters": [
4941
+ {
4942
+ "name": "props",
4943
+ "optional": true,
4944
+ "type": {
4945
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4946
+ }
4947
+ }
4948
+ ],
4949
+ "returns": {
4950
+ "type": {
4951
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4952
+ }
3530
4953
  }
3531
4954
  },
3532
4955
  {
3533
4956
  "abstract": true,
3534
4957
  "docs": {
3535
- "default": "CDK's default LogGroup",
4958
+ "default": "average over 5 minutes",
4959
+ "remarks": "Units: Percentage\n\nReporting Level: Application, Operator, Task, Parallelism",
3536
4960
  "stability": "experimental",
3537
- "summary": "The log group to send log entries to."
4961
+ "summary": "Derived from managedMemoryUsed/managedMemoryTotal."
3538
4962
  },
3539
- "immutable": true,
3540
4963
  "locationInModule": {
3541
4964
  "filename": "lib/application.ts",
3542
- "line": 184
4965
+ "line": 301
3543
4966
  },
3544
- "name": "logGroup",
3545
- "optional": true,
3546
- "type": {
3547
- "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
4967
+ "name": "metricManagedMemoryUtilization",
4968
+ "parameters": [
4969
+ {
4970
+ "name": "props",
4971
+ "optional": true,
4972
+ "type": {
4973
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
4974
+ }
4975
+ }
4976
+ ],
4977
+ "returns": {
4978
+ "type": {
4979
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
4980
+ }
3548
4981
  }
3549
4982
  },
3550
4983
  {
3551
4984
  "abstract": true,
3552
4985
  "docs": {
3553
- "default": "FlinkLogLevel.INFO",
4986
+ "default": "sum over 5 minutes",
4987
+ "remarks": "Units: Count\n\nReporting Level: Application",
3554
4988
  "stability": "experimental",
3555
- "summary": "The level of log verbosity from the Flink application."
4989
+ "summary": "The number of times checkpointing has failed."
3556
4990
  },
3557
- "immutable": true,
3558
4991
  "locationInModule": {
3559
4992
  "filename": "lib/application.ts",
3560
- "line": 113
4993
+ "line": 106
3561
4994
  },
3562
- "name": "logLevel",
3563
- "optional": true,
3564
- "type": {
3565
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.LogLevel"
4995
+ "name": "metricNumberOfFailedCheckpoints",
4996
+ "parameters": [
4997
+ {
4998
+ "name": "props",
4999
+ "optional": true,
5000
+ "type": {
5001
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5002
+ }
5003
+ }
5004
+ ],
5005
+ "returns": {
5006
+ "type": {
5007
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5008
+ }
3566
5009
  }
3567
5010
  },
3568
5011
  {
3569
5012
  "abstract": true,
3570
5013
  "docs": {
3571
- "default": "MetricsLevel.APPLICATION",
3572
- "remarks": "Use caution with Parallelism level metrics. Parallelism granularity logs\nmetrics for each parallel thread and can quickly become expensive when\nparallelism is high (e.g. > 64).",
5014
+ "default": "sum over 5 minutes",
5015
+ "remarks": "Units: Count\n\nReporting Level: Application, Operator, Task, Parallelism",
3573
5016
  "stability": "experimental",
3574
- "summary": "Describes the granularity of the CloudWatch metrics for an application."
5017
+ "summary": "The number of records this operator or task has dropped due to arriving late."
3575
5018
  },
3576
- "immutable": true,
3577
5019
  "locationInModule": {
3578
5020
  "filename": "lib/application.ts",
3579
- "line": 123
5021
+ "line": 246
3580
5022
  },
3581
- "name": "metricsLevel",
3582
- "optional": true,
3583
- "type": {
3584
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.MetricsLevel"
5023
+ "name": "metricNumLateRecordsDropped",
5024
+ "parameters": [
5025
+ {
5026
+ "name": "props",
5027
+ "optional": true,
5028
+ "type": {
5029
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5030
+ }
5031
+ }
5032
+ ],
5033
+ "returns": {
5034
+ "type": {
5035
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5036
+ }
3585
5037
  }
3586
5038
  },
3587
5039
  {
3588
5040
  "abstract": true,
3589
5041
  "docs": {
3590
- "default": "5 seconds",
5042
+ "default": "average over 5 minutes",
5043
+ "remarks": "Units: Count\n\nReporting Level: Application, Operator, Task, Parallelism",
3591
5044
  "stability": "experimental",
3592
- "summary": "The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint."
5045
+ "summary": "The total number of records this application, operator, or task has received."
3593
5046
  },
3594
- "immutable": true,
3595
5047
  "locationInModule": {
3596
5048
  "filename": "lib/application.ts",
3597
- "line": 106
5049
+ "line": 200
3598
5050
  },
3599
- "name": "minPauseBetweenCheckpoints",
3600
- "optional": true,
3601
- "type": {
3602
- "fqn": "aws-cdk-lib.Duration"
5051
+ "name": "metricNumRecordsIn",
5052
+ "parameters": [
5053
+ {
5054
+ "name": "props",
5055
+ "optional": true,
5056
+ "type": {
5057
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5058
+ }
5059
+ }
5060
+ ],
5061
+ "returns": {
5062
+ "type": {
5063
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5064
+ }
3603
5065
  }
3604
5066
  },
3605
5067
  {
3606
5068
  "abstract": true,
3607
5069
  "docs": {
3608
- "default": "1",
3609
- "remarks": "Kinesis Data Analytics can\nstop the app, increase the parallelism, and start the app again if\nautoScalingEnabled is true (the default value).",
5070
+ "default": "average over 5 minutes",
5071
+ "remarks": "Units: Count/Second\n\nReporting Level: Application, Operator, Task, Parallelism",
3610
5072
  "stability": "experimental",
3611
- "summary": "The initial parallelism for the application."
5073
+ "summary": "The total number of records this application, operator or task has received per second."
3612
5074
  },
3613
- "immutable": true,
3614
5075
  "locationInModule": {
3615
5076
  "filename": "lib/application.ts",
3616
- "line": 140
5077
+ "line": 212
3617
5078
  },
3618
- "name": "parallelism",
3619
- "optional": true,
3620
- "type": {
3621
- "primitive": "number"
5079
+ "name": "metricNumRecordsInPerSecond",
5080
+ "parameters": [
5081
+ {
5082
+ "name": "props",
5083
+ "optional": true,
5084
+ "type": {
5085
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5086
+ }
5087
+ }
5088
+ ],
5089
+ "returns": {
5090
+ "type": {
5091
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5092
+ }
3622
5093
  }
3623
5094
  },
3624
5095
  {
3625
5096
  "abstract": true,
3626
5097
  "docs": {
3627
- "default": "1",
5098
+ "default": "average over 5 minutes",
5099
+ "remarks": "Units: Count\n\nReporting Level: Application, Operator, Task, Parallelism",
3628
5100
  "stability": "experimental",
3629
- "summary": "The Flink parallelism allowed per Kinesis Processing Unit (KPU)."
5101
+ "summary": "The total number of records this application, operator or task has emitted."
3630
5102
  },
3631
- "immutable": true,
3632
5103
  "locationInModule": {
3633
5104
  "filename": "lib/application.ts",
3634
- "line": 147
5105
+ "line": 223
3635
5106
  },
3636
- "name": "parallelismPerKpu",
3637
- "optional": true,
3638
- "type": {
3639
- "primitive": "number"
5107
+ "name": "metricNumRecordsOut",
5108
+ "parameters": [
5109
+ {
5110
+ "name": "props",
5111
+ "optional": true,
5112
+ "type": {
5113
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5114
+ }
5115
+ }
5116
+ ],
5117
+ "returns": {
5118
+ "type": {
5119
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5120
+ }
3640
5121
  }
3641
5122
  },
3642
5123
  {
3643
5124
  "abstract": true,
3644
5125
  "docs": {
3645
- "default": "No property group configuration provided to the Flink app",
3646
- "remarks": "You can use these property groups to pass\narbitrary runtime configuration values to your Flink app.",
5126
+ "default": "average over 5 minutes",
5127
+ "remarks": "Units: Count/Second\n\nReporting Level: Application, Operator, Task, Parallelism",
3647
5128
  "stability": "experimental",
3648
- "summary": "Configuration PropertyGroups."
5129
+ "summary": "The total number of records this application, operator or task has emitted per second."
3649
5130
  },
3650
- "immutable": true,
3651
5131
  "locationInModule": {
3652
5132
  "filename": "lib/application.ts",
3653
- "line": 162
5133
+ "line": 235
3654
5134
  },
3655
- "name": "propertyGroups",
3656
- "optional": true,
3657
- "type": {
3658
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.PropertyGroups"
5135
+ "name": "metricNumRecordsOutPerSecond",
5136
+ "parameters": [
5137
+ {
5138
+ "name": "props",
5139
+ "optional": true,
5140
+ "type": {
5141
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5142
+ }
5143
+ }
5144
+ ],
5145
+ "returns": {
5146
+ "type": {
5147
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5148
+ }
3659
5149
  }
3660
5150
  },
3661
5151
  {
3662
5152
  "abstract": true,
3663
5153
  "docs": {
3664
- "default": "RemovalPolicy.DESTROY",
5154
+ "default": "sum over 5 minutes",
5155
+ "remarks": "Units: Count\n\nReporting Level: Application",
3665
5156
  "stability": "experimental",
3666
- "summary": "Provide a RemovalPolicy to override the default."
5157
+ "summary": "The total number of old garbage collection operations that have occurred across all task managers."
3667
5158
  },
3668
- "immutable": true,
3669
5159
  "locationInModule": {
3670
5160
  "filename": "lib/application.ts",
3671
5161
  "line": 177
3672
5162
  },
3673
- "name": "removalPolicy",
3674
- "optional": true,
3675
- "type": {
3676
- "fqn": "aws-cdk-lib.RemovalPolicy"
5163
+ "name": "metricOldGenerationGCCount",
5164
+ "parameters": [
5165
+ {
5166
+ "name": "props",
5167
+ "optional": true,
5168
+ "type": {
5169
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5170
+ }
5171
+ }
5172
+ ],
5173
+ "returns": {
5174
+ "type": {
5175
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5176
+ }
3677
5177
  }
3678
5178
  },
3679
5179
  {
3680
5180
  "abstract": true,
3681
5181
  "docs": {
3682
- "default": "- a new Role will be created",
3683
- "remarks": "Prefer omitting\nthis property and using the default role.",
5182
+ "default": "sum over 5 minutes",
5183
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
3684
5184
  "stability": "experimental",
3685
- "summary": "A role to use to grant permissions to your application."
5185
+ "summary": "The total time spent performing old garbage collection operations."
3686
5186
  },
3687
- "immutable": true,
3688
5187
  "locationInModule": {
3689
5188
  "filename": "lib/application.ts",
3690
- "line": 170
5189
+ "line": 165
3691
5190
  },
3692
- "name": "role",
3693
- "optional": true,
3694
- "type": {
3695
- "fqn": "aws-cdk-lib.aws_iam.IRole"
5191
+ "name": "metricOldGenerationGCTime",
5192
+ "parameters": [
5193
+ {
5194
+ "name": "props",
5195
+ "optional": true,
5196
+ "type": {
5197
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5198
+ }
5199
+ }
5200
+ ],
5201
+ "returns": {
5202
+ "type": {
5203
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5204
+ }
3696
5205
  }
3697
5206
  },
3698
5207
  {
3699
5208
  "abstract": true,
3700
5209
  "docs": {
3701
- "default": "true",
5210
+ "default": "average over 5 minutes",
5211
+ "remarks": "Units: Count\n\n Reporting Level: Application",
3702
5212
  "stability": "experimental",
3703
- "summary": "Determines if Flink snapshots are enabled."
5213
+ "summary": "The total number of live threads used by the application."
3704
5214
  },
3705
- "immutable": true,
3706
5215
  "locationInModule": {
3707
5216
  "filename": "lib/application.ts",
3708
- "line": 154
5217
+ "line": 188
3709
5218
  },
3710
- "name": "snapshotsEnabled",
3711
- "optional": true,
3712
- "type": {
3713
- "primitive": "boolean"
5219
+ "name": "metricThreadsCount",
5220
+ "parameters": [
5221
+ {
5222
+ "name": "props",
5223
+ "optional": true,
5224
+ "type": {
5225
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
5226
+ }
5227
+ }
5228
+ ],
5229
+ "returns": {
5230
+ "type": {
5231
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
5232
+ }
3714
5233
  }
3715
- }
3716
- ],
3717
- "symbolId": "lib/application:ApplicationProps"
3718
- },
3719
- "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication": {
3720
- "assembly": "@aws-cdk/aws-kinesisanalytics-flink-alpha",
3721
- "docs": {
3722
- "stability": "experimental",
3723
- "summary": "An interface expressing the public properties on both an imported and CDK-created Flink application."
3724
- },
3725
- "fqn": "@aws-cdk/aws-kinesisanalytics-flink-alpha.IApplication",
3726
- "interfaces": [
3727
- "aws-cdk-lib.IResource",
3728
- "aws-cdk-lib.aws_iam.IGrantable"
3729
- ],
3730
- "kind": "interface",
3731
- "locationInModule": {
3732
- "filename": "lib/application.ts",
3733
- "line": 16
3734
- },
3735
- "methods": [
5234
+ },
3736
5235
  {
3737
5236
  "abstract": true,
3738
5237
  "docs": {
5238
+ "default": "sample count over 5 minutes",
5239
+ "remarks": "Units: Milliseconds\n\nReporting Level: Application",
3739
5240
  "stability": "experimental",
3740
- "summary": "Convenience method for adding a policy statement to the application role."
5241
+ "summary": "The time that the job has been running without interruption."
3741
5242
  },
3742
5243
  "locationInModule": {
3743
5244
  "filename": "lib/application.ts",
3744
- "line": 39
5245
+ "line": 83
3745
5246
  },
3746
- "name": "addToRolePolicy",
5247
+ "name": "metricUptime",
3747
5248
  "parameters": [
3748
5249
  {
3749
- "name": "policyStatement",
5250
+ "name": "props",
5251
+ "optional": true,
3750
5252
  "type": {
3751
- "fqn": "aws-cdk-lib.aws_iam.PolicyStatement"
5253
+ "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
3752
5254
  }
3753
5255
  }
3754
5256
  ],
3755
5257
  "returns": {
3756
5258
  "type": {
3757
- "primitive": "boolean"
5259
+ "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
3758
5260
  }
3759
5261
  }
3760
5262
  }
@@ -3773,7 +5275,7 @@
3773
5275
  "immutable": true,
3774
5276
  "locationInModule": {
3775
5277
  "filename": "lib/application.ts",
3776
- "line": 22
5278
+ "line": 23
3777
5279
  },
3778
5280
  "name": "applicationArn",
3779
5281
  "type": {
@@ -3792,7 +5294,7 @@
3792
5294
  "immutable": true,
3793
5295
  "locationInModule": {
3794
5296
  "filename": "lib/application.ts",
3795
- "line": 29
5297
+ "line": 30
3796
5298
  },
3797
5299
  "name": "applicationName",
3798
5300
  "type": {
@@ -3808,7 +5310,7 @@
3808
5310
  "immutable": true,
3809
5311
  "locationInModule": {
3810
5312
  "filename": "lib/application.ts",
3811
- "line": 34
5313
+ "line": 35
3812
5314
  },
3813
5315
  "name": "role",
3814
5316
  "optional": true,
@@ -3943,7 +5445,7 @@
3943
5445
  "custom": {
3944
5446
  "exampleMetadata": "lit=test/integ.application.lit.ts ! show infused"
3945
5447
  },
3946
- "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nnew flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n///! hide\n\napp.synth();",
5448
+ "example": "import * as path from 'path';\nimport * as core from 'aws-cdk-lib';\nimport * as flink from '../lib';\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\n\nconst app = new core.App();\nconst stack = new core.Stack(app, 'FlinkAppTest');\n\nconst flinkApp = new flink.Application(stack, 'App', {\n code: flink.ApplicationCode.fromAsset(path.join(__dirname, 'code-asset')),\n runtime: flink.Runtime.FLINK_1_11,\n});\n\nnew cloudwatch.Alarm(stack, 'Alarm', {\n metric: flinkApp.metricFullRestarts(),\n evaluationPeriods: 1,\n threshold: 3,\n});\n///! hide\n\napp.synth();",
3947
5449
  "stability": "experimental",
3948
5450
  "summary": "Available Flink runtimes for Kinesis Analytics."
3949
5451
  },
@@ -4069,6 +5571,6 @@
4069
5571
  "symbolId": "lib/types:Runtime"
4070
5572
  }
4071
5573
  },
4072
- "version": "2.16.0-alpha.0",
5574
+ "version": "2.19.0-alpha.0",
4073
5575
  "fingerprint": "**********"
4074
5576
  }