Package-level declarations

Types

Link copied to clipboard
data class ApplicationCatalogConfiguration(val glueDataCatalogConfiguration: ApplicationGlueDataCatalogConfiguration? = null)

The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

Link copied to clipboard
data class ApplicationCheckpointConfiguration(val checkpointInterval: Int? = null, val checkpointingEnabled: Boolean? = null, val configurationType: ApplicationCheckpointConfigurationConfigurationType, val minPauseBetweenCheckpoints: Int? = null)

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

Link copied to clipboard

Describes code configuration for an application.

Link copied to clipboard
data class ApplicationCodeContent(val s3ContentLocation: ApplicationS3ContentLocation? = null, val textContent: String? = null, val zipFileContent: String? = null)

Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.

Link copied to clipboard
data class ApplicationConfiguration(val applicationCodeConfiguration: ApplicationCodeConfiguration? = null, val applicationSnapshotConfiguration: ApplicationSnapshotConfiguration? = null, val applicationSystemRollbackConfiguration: ApplicationSystemRollbackConfiguration? = null, val environmentProperties: ApplicationEnvironmentProperties? = null, val flinkApplicationConfiguration: ApplicationFlinkApplicationConfiguration? = null, val sqlApplicationConfiguration: ApplicationSqlApplicationConfiguration? = null, val vpcConfigurations: List<ApplicationVpcConfiguration>? = null, val zeppelinApplicationConfiguration: ApplicationZeppelinApplicationConfiguration? = null)

Specifies the creation parameters for a Kinesis Data Analytics application.

Link copied to clipboard
data class ApplicationCsvMappingParameters(val recordColumnDelimiter: String, val recordRowDelimiter: String)

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\n' as the row delimiter and a comma (",") as the column delimiter: "name1", "address1" "name2", "address2"

Link copied to clipboard
data class ApplicationCustomArtifactConfiguration(val artifactType: ApplicationCustomArtifactConfigurationArtifactType, val mavenReference: ApplicationMavenReference? = null, val s3ContentLocation: ApplicationS3ContentLocation? = null)

The configuration of connectors and user-defined functions.

The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

Link copied to clipboard
data class ApplicationEnvironmentProperties(val propertyGroups: List<ApplicationPropertyGroup>? = null)

Describes execution properties for a Flink-based Kinesis Data Analytics application.

Link copied to clipboard
data class ApplicationFlinkApplicationConfiguration(val checkpointConfiguration: ApplicationCheckpointConfiguration? = null, val monitoringConfiguration: ApplicationMonitoringConfiguration? = null, val parallelismConfiguration: ApplicationParallelismConfiguration? = null)

Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.

Link copied to clipboard
data class ApplicationFlinkRunConfiguration(val allowNonRestoredState: Boolean? = null)

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

Link copied to clipboard
data class ApplicationGlueDataCatalogConfiguration(val databaseArn: String? = null)

The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.

Link copied to clipboard
data class ApplicationInput(val inputParallelism: ApplicationInputParallelism? = null, val inputProcessingConfiguration: ApplicationInputProcessingConfiguration? = null, val inputSchema: ApplicationInputSchema, val kinesisFirehoseInput: ApplicationKinesisFirehoseInput? = null, val kinesisStreamsInput: ApplicationKinesisStreamsInput? = null, val namePrefix: String)

When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.

Link copied to clipboard
data class ApplicationInputLambdaProcessor(val resourceArn: String)

An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.

Link copied to clipboard
data class ApplicationInputParallelism(val count: Int? = null)

For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.

Link copied to clipboard
data class ApplicationInputProcessingConfiguration(val inputLambdaProcessor: ApplicationInputLambdaProcessor? = null)

For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda.

Link copied to clipboard
data class ApplicationInputSchema(val recordColumns: List<ApplicationRecordColumn>, val recordEncoding: ApplicationInputSchemaRecordEncoding? = null, val recordFormat: ApplicationRecordFormat)

For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

Link copied to clipboard
data class ApplicationJsonMappingParameters(val recordRowPath: String)

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.

Link copied to clipboard
data class ApplicationKinesisFirehoseInput(val resourceArn: String)

For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).

Link copied to clipboard
data class ApplicationKinesisStreamsInput(val resourceArn: String)

Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).

Link copied to clipboard
data class ApplicationMaintenanceConfiguration(val applicationMaintenanceWindowStartTime: String)

Describes the maintenance configuration for the application.

Link copied to clipboard
data class ApplicationMappingParameters(val csvMappingParameters: ApplicationCsvMappingParameters? = null, val jsonMappingParameters: ApplicationJsonMappingParameters? = null)

When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

Link copied to clipboard
data class ApplicationMavenReference(val artifactId: String, val groupId: String, val version: String)

The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.

Link copied to clipboard

Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring.

Link copied to clipboard
data class ApplicationParallelismConfiguration(val autoScalingEnabled: Boolean? = null, val configurationType: ApplicationParallelismConfigurationConfigurationType, val parallelism: Int? = null, val parallelismPerKpu: Int? = null)

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation

Link copied to clipboard
data class ApplicationPropertyGroup(val propertyGroupId: String? = null, val propertyMap: Map<String, String>? = null)

Property key-value pairs passed into an application.

Link copied to clipboard
data class ApplicationRecordColumn(val mapping: String? = null, val name: String, val sqlType: String)

For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. Also used to describe the format of the reference data source.

Link copied to clipboard
data class ApplicationRecordFormat(val mappingParameters: ApplicationMappingParameters? = null, val recordFormatType: ApplicationRecordFormatRecordFormatType)

For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

Link copied to clipboard
data class ApplicationRestoreConfiguration(val applicationRestoreType: ApplicationRestoreConfigurationApplicationRestoreType, val snapshotName: String? = null)

Describes the restore behavior of a restarting application.

Link copied to clipboard
data class ApplicationRunConfiguration(val applicationRestoreConfiguration: ApplicationRestoreConfiguration? = null, val flinkRunConfiguration: ApplicationFlinkRunConfiguration? = null)

Identifies the run configuration (start parameters) of a Kinesis Data Analytics application. This section is evaluated only on stack updates for applications in running RUNNING state and has no effect during manual application start.

Link copied to clipboard
data class ApplicationS3ContentBaseLocation(val basePath: String? = null, val bucketArn: String)

The base location of the Amazon Data Analytics application.

Link copied to clipboard
data class ApplicationS3ContentLocation(val bucketArn: String, val fileKey: String, val objectVersion: String? = null)

The location of an application or a custom artifact.

Link copied to clipboard
data class ApplicationSnapshotConfiguration(val snapshotsEnabled: Boolean)

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

Link copied to clipboard

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

Link copied to clipboard
data class ApplicationSystemRollbackConfiguration(val rollbackEnabled: Boolean)

Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.

Link copied to clipboard
data class ApplicationVpcConfiguration(val securityGroupIds: List<String>, val subnetIds: List<String>)

Describes the parameters of a VPC used by the application.

data class ApplicationZeppelinApplicationConfiguration(val catalogConfiguration: ApplicationCatalogConfiguration? = null, val customArtifactsConfiguration: List<ApplicationCustomArtifactConfiguration>? = null, val deployAsApplicationConfiguration: ApplicationDeployAsApplicationConfiguration? = null, val monitoringConfiguration: ApplicationZeppelinMonitoringConfiguration? = null)

The configuration of a Kinesis Data Analytics Studio notebook.

Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.

Link copied to clipboard
data class GetApplicationResult(val applicationConfiguration: ApplicationConfiguration? = null, val applicationDescription: String? = null, val applicationMaintenanceConfiguration: ApplicationMaintenanceConfiguration? = null, val runtimeEnvironment: String? = null, val serviceExecutionRole: String? = null, val tags: List<Tag>? = null)