@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:28.870Z")
public interface ApplicationProps
Example:
import path.*; import software.amazon.awscdk.core.*; import software.amazon.awscdk.services.kinesis.analytics.flink.*; import software.amazon.awscdk.services.cloudwatch.*; App app = new App(); Stack stack = new Stack(app, "FlinkAppTest"); Application flinkApp = Application.Builder.create(stack, "App") .code(ApplicationCode.fromAsset(join(__dirname, "code-asset"))) .runtime(Runtime.FLINK_1_11) .build(); Alarm.Builder.create(stack, "Alarm") .metric(flinkApp.metricFullRestarts()) .evaluationPeriods(1) .threshold(3) .build(); app.synth();
Modifier and Type | Interface and Description |
---|---|
static class |
ApplicationProps.Builder
A builder for
ApplicationProps |
static class |
ApplicationProps.Jsii$Proxy
An implementation for
ApplicationProps |
Modifier and Type | Method and Description |
---|---|
static ApplicationProps.Builder |
builder() |
default java.lang.String |
getApplicationName()
(experimental) A name for your Application that is unique to an AWS account.
|
default java.lang.Boolean |
getAutoScalingEnabled()
(experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.
|
default java.lang.Boolean |
getCheckpointingEnabled()
(experimental) Whether checkpointing is enabled while your application runs.
|
default Duration |
getCheckpointInterval()
(experimental) The interval between checkpoints.
|
ApplicationCode |
getCode()
(experimental) The Flink code asset to run.
|
default ILogGroup |
getLogGroup()
(experimental) The log group to send log entries to.
|
default LogLevel |
getLogLevel()
(experimental) The level of log verbosity from the Flink application.
|
default MetricsLevel |
getMetricsLevel()
(experimental) Describes the granularity of the CloudWatch metrics for an application.
|
default Duration |
getMinPauseBetweenCheckpoints()
(experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.
|
default java.lang.Number |
getParallelism()
(experimental) The initial parallelism for the application.
|
default java.lang.Number |
getParallelismPerKpu()
(experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).
|
default PropertyGroups |
getPropertyGroups()
(experimental) Configuration PropertyGroups.
|
default RemovalPolicy |
getRemovalPolicy()
(experimental) Provide a RemovalPolicy to override the default.
|
default IRole |
getRole()
(experimental) A role to use to grant permissions to your application.
|
Runtime |
getRuntime()
(experimental) The Flink version to use for this application.
|
default java.lang.Boolean |
getSnapshotsEnabled()
(experimental) Determines if Flink snapshots are enabled.
|
ApplicationCode getCode()
Runtime getRuntime()
default java.lang.String getApplicationName()
Default: - CloudFormation-generated name
default java.lang.Boolean getAutoScalingEnabled()
Default: true
default java.lang.Boolean getCheckpointingEnabled()
Default: true
default Duration getCheckpointInterval()
Default: 1 minute
default ILogGroup getLogGroup()
Default: CDK's default LogGroup
default LogLevel getLogLevel()
Default: FlinkLogLevel.INFO
default MetricsLevel getMetricsLevel()
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
default Duration getMinPauseBetweenCheckpoints()
Default: 5 seconds
default java.lang.Number getParallelism()
Kinesis Data Analytics can stop the app, increase the parallelism, and start the app again if autoScalingEnabled is true (the default value).
Default: 1
default java.lang.Number getParallelismPerKpu()
Default: 1
default PropertyGroups getPropertyGroups()
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
default RemovalPolicy getRemovalPolicy()
Default: RemovalPolicy.DESTROY
default IRole getRole()
Prefer omitting this property and using the default role.
Default: - a new Role will be created
default java.lang.Boolean getSnapshotsEnabled()
Default: true
static ApplicationProps.Builder builder()
ApplicationProps.Builder
of ApplicationProps