software.amazon.awscdk.services.kinesis.analytics.flink

Class Application.Builder

java.lang.Object

software.amazon.awscdk.services.kinesis.analytics.flink.Application.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Application>

Enclosing class:

Application

@Stability(value=Experimental)
public static final class Application.Builder
extends Object
implements software.amazon.jsii.Builder<Application>

(experimental) A fluent builder for Application.

Method Summary

Modifier and Type	Method and Description
Application.Builder	applicationName(String applicationName) (experimental) A name for your Application that is unique to an AWS account.
Application.Builder	autoScalingEnabled(Boolean autoScalingEnabled) (experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.
Application	build()
Application.Builder	checkpointingEnabled(Boolean checkpointingEnabled) (experimental) Whether checkpointing is enabled while your application runs.
Application.Builder	checkpointInterval(Duration checkpointInterval) (experimental) The interval between checkpoints.
Application.Builder	code(ApplicationCode code) (experimental) The Flink code asset to run.
static Application.Builder	create(software.constructs.Construct scope, String id)
Application.Builder	logGroup(ILogGroup logGroup) (experimental) The log group to send log entries to.
Application.Builder	logLevel(LogLevel logLevel) (experimental) The level of log verbosity from the Flink application.
Application.Builder	metricsLevel(MetricsLevel metricsLevel) (experimental) Describes the granularity of the CloudWatch metrics for an application.
Application.Builder	minPauseBetweenCheckpoints(Duration minPauseBetweenCheckpoints) (experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.
Application.Builder	parallelism(Number parallelism) (experimental) The initial parallelism for the application.
Application.Builder	parallelismPerKpu(Number parallelismPerKpu) (experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).
Application.Builder	propertyGroups(PropertyGroups propertyGroups) (experimental) Configuration PropertyGroups.
Application.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) Provide a RemovalPolicy to override the default.
Application.Builder	role(IRole role) (experimental) A role to use to grant permissions to your application.
Application.Builder	runtime(Runtime runtime) (experimental) The Flink version to use for this application.
Application.Builder	snapshotsEnabled(Boolean snapshotsEnabled) (experimental) Determines if Flink snapshots are enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static Application.Builder create(software.constructs.Construct scope,
                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Application.Builder.

code

@Stability(value=Experimental)
public Application.Builder code(ApplicationCode code)

(experimental) The Flink code asset to run.

Parameters:

code - The Flink code asset to run. This parameter is required.

Returns:

this

runtime

@Stability(value=Experimental)
public Application.Builder runtime(Runtime runtime)

(experimental) The Flink version to use for this application.

Parameters:

runtime - The Flink version to use for this application. This parameter is required.

Returns:

this

applicationName

@Stability(value=Experimental)
public Application.Builder applicationName(String applicationName)

(experimental) A name for your Application that is unique to an AWS account.

Default: - CloudFormation-generated name

Parameters:

applicationName - A name for your Application that is unique to an AWS account. This parameter is required.

Returns:

this

autoScalingEnabled

@Stability(value=Experimental)
public Application.Builder autoScalingEnabled(Boolean autoScalingEnabled)

(experimental) Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage.

Default: true

Parameters:

autoScalingEnabled - Whether the Kinesis Data Analytics service can increase the parallelism of the application in response to resource usage. This parameter is required.

Returns:

this

checkpointingEnabled

@Stability(value=Experimental)
public Application.Builder checkpointingEnabled(Boolean checkpointingEnabled)

(experimental) Whether checkpointing is enabled while your application runs.

Default: true

Parameters:

checkpointingEnabled - Whether checkpointing is enabled while your application runs. This parameter is required.

Returns:

this

checkpointInterval

@Stability(value=Experimental)
public Application.Builder checkpointInterval(Duration checkpointInterval)

(experimental) The interval between checkpoints.

Default: 1 minute

Parameters:

checkpointInterval - The interval between checkpoints. This parameter is required.

Returns:

this

logGroup

@Stability(value=Experimental)
public Application.Builder logGroup(ILogGroup logGroup)

(experimental) The log group to send log entries to.

Default: CDK's default LogGroup

Parameters:

logGroup - The log group to send log entries to. This parameter is required.

Returns:

this

logLevel

@Stability(value=Experimental)
public Application.Builder logLevel(LogLevel logLevel)

(experimental) The level of log verbosity from the Flink application.

Default: FlinkLogLevel.INFO

Parameters:

logLevel - The level of log verbosity from the Flink application. This parameter is required.

Returns:

this

metricsLevel

@Stability(value=Experimental)
public Application.Builder metricsLevel(MetricsLevel metricsLevel)

(experimental) Describes the granularity of the CloudWatch metrics for an application.

Use caution with Parallelism level metrics. Parallelism granularity logs metrics for each parallel thread and can quickly become expensive when parallelism is high (e.g. > 64).

Default: MetricsLevel.APPLICATION

Parameters:

metricsLevel - Describes the granularity of the CloudWatch metrics for an application. This parameter is required.

Returns:

this

minPauseBetweenCheckpoints

@Stability(value=Experimental)
public Application.Builder minPauseBetweenCheckpoints(Duration minPauseBetweenCheckpoints)

(experimental) The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint.

Default: 5 seconds

Parameters:

minPauseBetweenCheckpoints - The minimum amount of time in to wait after a checkpoint finishes to start a new checkpoint. This parameter is required.

Returns:

this

parallelism

@Stability(value=Experimental)
public Application.Builder parallelism(Number parallelism)

(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

Parameters:

parallelism - The initial parallelism for the application. This parameter is required.

Returns:

this

parallelismPerKpu

@Stability(value=Experimental)
public Application.Builder parallelismPerKpu(Number parallelismPerKpu)

(experimental) The Flink parallelism allowed per Kinesis Processing Unit (KPU).

Default: 1

Parameters:

parallelismPerKpu - The Flink parallelism allowed per Kinesis Processing Unit (KPU). This parameter is required.

Returns:

this

propertyGroups

@Stability(value=Experimental)
public Application.Builder propertyGroups(PropertyGroups propertyGroups)

(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

Parameters:

propertyGroups - Configuration PropertyGroups. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Experimental)
public Application.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) Provide a RemovalPolicy to override the default.

Default: RemovalPolicy.DESTROY

Parameters:

removalPolicy - Provide a RemovalPolicy to override the default. This parameter is required.

Returns:

this

role

@Stability(value=Experimental)
public Application.Builder role(IRole role)

(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

Parameters:

role - A role to use to grant permissions to your application. This parameter is required.

Returns:

this

snapshotsEnabled

@Stability(value=Experimental)
public Application.Builder snapshotsEnabled(Boolean snapshotsEnabled)

(experimental) Determines if Flink snapshots are enabled.

Default: true

Parameters:

snapshotsEnabled - Determines if Flink snapshots are enabled. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Application build()

Specified by:

build in interface software.amazon.jsii.Builder<Application>