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