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

Class ApplicationProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationProps>

Enclosing interface:

ApplicationProps

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

A builder for ApplicationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApplicationProps.Builder	applicationName(String applicationName)	Sets the value of ApplicationProps.getApplicationName()
ApplicationProps.Builder	autoScalingEnabled(Boolean autoScalingEnabled)	Sets the value of ApplicationProps.getAutoScalingEnabled()
ApplicationProps	build()	Builds the configured instance.
ApplicationProps.Builder	checkpointingEnabled(Boolean checkpointingEnabled)	Sets the value of ApplicationProps.getCheckpointingEnabled()
ApplicationProps.Builder	checkpointInterval(Duration checkpointInterval)	Sets the value of ApplicationProps.getCheckpointInterval()
ApplicationProps.Builder	code(ApplicationCode code)	Sets the value of ApplicationProps.getCode()
ApplicationProps.Builder	logGroup(ILogGroup logGroup)	Sets the value of ApplicationProps.getLogGroup()
ApplicationProps.Builder	logLevel(LogLevel logLevel)	Sets the value of ApplicationProps.getLogLevel()
ApplicationProps.Builder	metricsLevel(MetricsLevel metricsLevel)	Sets the value of ApplicationProps.getMetricsLevel()
ApplicationProps.Builder	minPauseBetweenCheckpoints(Duration minPauseBetweenCheckpoints)	Sets the value of ApplicationProps.getMinPauseBetweenCheckpoints()
ApplicationProps.Builder	parallelism(Number parallelism)	Sets the value of ApplicationProps.getParallelism()
ApplicationProps.Builder	parallelismPerKpu(Number parallelismPerKpu)	Sets the value of ApplicationProps.getParallelismPerKpu()
ApplicationProps.Builder	propertyGroups(PropertyGroups propertyGroups)	Sets the value of ApplicationProps.getPropertyGroups()
ApplicationProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of ApplicationProps.getRemovalPolicy()
ApplicationProps.Builder	role(IRole role)	Sets the value of ApplicationProps.getRole()
ApplicationProps.Builder	runtime(Runtime runtime)	Sets the value of ApplicationProps.getRuntime()
ApplicationProps.Builder	snapshotsEnabled(Boolean snapshotsEnabled)	Sets the value of ApplicationProps.getSnapshotsEnabled()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

code

@Stability(Experimental)
public ApplicationProps.Builder code(ApplicationCode code)

Sets the value of ApplicationProps.getCode()

Parameters:

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

Returns:

this

runtime

@Stability(Experimental)
public ApplicationProps.Builder runtime(Runtime runtime)

Sets the value of ApplicationProps.getRuntime()

Parameters:

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

Returns:

this

applicationName

@Stability(Experimental)
public ApplicationProps.Builder applicationName(String applicationName)

Sets the value of ApplicationProps.getApplicationName()

Parameters:

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

Returns:

this

autoScalingEnabled

@Stability(Experimental)
public ApplicationProps.Builder autoScalingEnabled(Boolean autoScalingEnabled)

Sets the value of ApplicationProps.getAutoScalingEnabled()

Parameters:

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

Returns:

this

checkpointingEnabled

@Stability(Experimental)
public ApplicationProps.Builder checkpointingEnabled(Boolean checkpointingEnabled)

Sets the value of ApplicationProps.getCheckpointingEnabled()

Parameters:

checkpointingEnabled - Whether checkpointing is enabled while your application runs.

Returns:

this

checkpointInterval

@Stability(Experimental)
public ApplicationProps.Builder checkpointInterval(Duration checkpointInterval)

Sets the value of ApplicationProps.getCheckpointInterval()

Parameters:

checkpointInterval - The interval between checkpoints.

Returns:

this

logGroup

@Stability(Experimental)
public ApplicationProps.Builder logGroup(ILogGroup logGroup)

Sets the value of ApplicationProps.getLogGroup()

Parameters:

logGroup - The log group to send log entries to.

Returns:

this

logLevel

@Stability(Experimental)
public ApplicationProps.Builder logLevel(LogLevel logLevel)

Sets the value of ApplicationProps.getLogLevel()

Parameters:

logLevel - The level of log verbosity from the Flink application.

Returns:

this

metricsLevel

@Stability(Experimental)
public ApplicationProps.Builder metricsLevel(MetricsLevel metricsLevel)

Sets the value of ApplicationProps.getMetricsLevel()

Parameters:

metricsLevel - 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).

Returns:

this

minPauseBetweenCheckpoints

@Stability(Experimental)
public ApplicationProps.Builder minPauseBetweenCheckpoints(Duration minPauseBetweenCheckpoints)

Sets the value of ApplicationProps.getMinPauseBetweenCheckpoints()

Parameters:

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

Returns:

this

parallelism

@Stability(Experimental)
public ApplicationProps.Builder parallelism(Number parallelism)

Sets the value of ApplicationProps.getParallelism()

Parameters:

parallelism - 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).

Returns:

this

parallelismPerKpu

@Stability(Experimental)
public ApplicationProps.Builder parallelismPerKpu(Number parallelismPerKpu)

Sets the value of ApplicationProps.getParallelismPerKpu()

Parameters:

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

Returns:

this

propertyGroups

@Stability(Experimental)
public ApplicationProps.Builder propertyGroups(PropertyGroups propertyGroups)

Sets the value of ApplicationProps.getPropertyGroups()

Parameters:

propertyGroups - Configuration PropertyGroups. You can use these property groups to pass arbitrary runtime configuration values to your Flink app.

Returns:

this

removalPolicy

@Stability(Experimental)
public ApplicationProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of ApplicationProps.getRemovalPolicy()

Parameters:

removalPolicy - Provide a RemovalPolicy to override the default.

Returns:

this

role

@Stability(Experimental)
public ApplicationProps.Builder role(IRole role)

Sets the value of ApplicationProps.getRole()

Parameters:

role - A role to use to grant permissions to your application. Prefer omitting this property and using the default role.

Returns:

this

snapshotsEnabled

@Stability(Experimental)
public ApplicationProps.Builder snapshotsEnabled(Boolean snapshotsEnabled)

Sets the value of ApplicationProps.getSnapshotsEnabled()

Parameters:

snapshotsEnabled - Determines if Flink snapshots are enabled.

Returns:

this

build

@Stability(Experimental)
public ApplicationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApplicationProps

Throws:

NullPointerException - if any required attribute was not provided