Interface ApplicationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
ApplicationProps.Jsii$Proxy
Example:
Bucket bucket; Application flinkApp = Application.Builder.create(this, "Application") .propertyGroups(Map.of( "FlinkApplicationProperties", Map.of( "inputStreamName", "my-input-kinesis-stream", "outputStreamName", "my-output-kinesis-stream"))) // ... .runtime(Runtime.FLINK_1_20) .code(ApplicationCode.fromBucket(bucket, "my-app.jar")) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forApplicationProps
static final class
An implementation forApplicationProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic ApplicationProps.Builder
builder()
default String
(experimental) A name for your Application that is unique to an AWS account.default Boolean
(experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.default Boolean
(experimental) Whether checkpointing is enabled while your application runs.default Duration
(experimental) The interval between checkpoints.getCode()
(experimental) The Flink code asset to run.default ILogGroup
(experimental) The log group to send log entries to.default LogLevel
(experimental) The level of log verbosity from the Flink application.default MetricsLevel
(experimental) Describes the granularity of the CloudWatch metrics for an application.default Duration
(experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.default Number
(experimental) The initial parallelism for the application.default Number
(experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).(experimental) Configuration PropertyGroups.default RemovalPolicy
(experimental) Provide a RemovalPolicy to override the default.default IRole
getRole()
(experimental) A role to use to grant permissions to your application.(experimental) The Flink version to use for this application.default List<ISecurityGroup>
(experimental) Security groups to use with a provided VPC.default Boolean
(experimental) Determines if Flink snapshots are enabled.default IVpc
getVpc()
(experimental) Deploy the Flink application in a VPC.default SubnetSelection
(experimental) Choose which VPC subnets to use.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCode
(experimental) The Flink code asset to run. -
getRuntime
(experimental) The Flink version to use for this application. -
getApplicationName
(experimental) A name for your Application that is unique to an AWS account.Default: - CloudFormation-generated name
-
getAutoScalingEnabled
(experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.Default: true
-
getCheckpointingEnabled
(experimental) Whether checkpointing is enabled while your application runs.Default: true
-
getCheckpointInterval
(experimental) The interval between checkpoints.Default: - 1 minute
-
getLogGroup
(experimental) The log group to send log entries to.Default: - CDK's default LogGroup
-
getLogLevel
(experimental) The level of log verbosity from the Flink application.Default: FlinkLogLevel.INFO
-
getMetricsLevel
(experimental) Describes the granularity of the CloudWatch metrics for an application.Use caution with Parallelism level metrics. Parallelism granularity logs metrics for each parallel thread and can quickly become expensive when parallelism is high (e.g. > 64).
Default: MetricsLevel.APPLICATION
-
getMinPauseBetweenCheckpoints
(experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.Default: - 5 seconds
-
getParallelism
(experimental) The initial parallelism for the application.Kinesis Data Analytics can stop the app, increase the parallelism, and start the app again if autoScalingEnabled is true (the default value).
Default: 1
-
getParallelismPerKpu
(experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).Default: 1
-
getPropertyGroups
(experimental) Configuration PropertyGroups.You can use these property groups to pass arbitrary runtime configuration values to your Flink app.
Default: - No property group configuration provided to the Flink app
-
getRemovalPolicy
(experimental) Provide a RemovalPolicy to override the default.Default: RemovalPolicy.DESTROY
-
getRole
(experimental) A role to use to grant permissions to your application.Prefer omitting this property and using the default role.
Default: - a new Role will be created
-
getSecurityGroups
(experimental) Security groups to use with a provided VPC.Default: - a new security group is created for this application.
-
getSnapshotsEnabled
(experimental) Determines if Flink snapshots are enabled.Default: true
-
getVpc
(experimental) Deploy the Flink application in a VPC.Default: - no VPC
-
getVpcSubnets
(experimental) Choose which VPC subnets to use.Default: - SubnetType.PRIVATE_WITH_EGRESS subnets
-
builder
- Returns:
- a
ApplicationProps.Builder
ofApplicationProps
-