Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-kinesisanalyticsv2-application.json
Parent schema serverless-framework-configuration
Type: object

Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesisanalyticsv2.git

Properties

RuntimeEnvironment string | Aws_CF_FunctionString required

The runtime environment for the application.

ServiceExecutionRole string | Aws_CF_FunctionString required

The Amazon Resource Name

ApplicationConfiguration object

Specifies the creation parameters for a Kinesis Data Analytics application.

7 nested properties
ApplicationCodeConfiguration object

Describes code configuration for an application.

2 nested properties
CodeContent object required

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

3 nested properties
ZipFileContent string | Aws_CF_FunctionString

The zip-format code for a Flink-based Kinesis Data Analytics application.

S3ContentLocation object

The location of an application or a custom artifact.

TextContent string | Aws_CF_FunctionString

The text-format code for a Flink-based Kinesis Data Analytics application.

CodeContentType string | Aws_CF_FunctionString required

Specifies whether the code content is in text or zip format.

ApplicationSnapshotConfiguration object

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

1 nested properties
SnapshotsEnabled boolean required

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

EnvironmentProperties object

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

1 nested properties
PropertyGroups PropertyGroup[]

Describes the execution property groups.

maxItems=50
FlinkApplicationConfiguration object

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

3 nested properties
CheckpointConfiguration object

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.

4 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

CheckpointingEnabled boolean

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

CheckpointInterval integer

Describes the interval in milliseconds between checkpoint operations.

format=int64min=1max=9223372036854776000
MinPauseBetweenCheckpoints integer

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

format=int64min=0max=9223372036854776000
MonitoringConfiguration object

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

3 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

MetricsLevel string | Aws_CF_FunctionString

Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

LogLevel string | Aws_CF_FunctionString

Describes the verbosity of the CloudWatch Logs for an application.

ParallelismConfiguration object

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

4 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

ParallelismPerKPU integer

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

min=1
Parallelism integer

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true.

min=1
AutoScalingEnabled boolean

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

SqlApplicationConfiguration object

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

1 nested properties
Inputs Input[]

The array of Input objects describing the input streams used by the application.

maxItems=1
ZeppelinApplicationConfiguration object

The configuration of a Kinesis Data Analytics Studio notebook.

4 nested properties
CatalogConfiguration object

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.

1 nested properties
GlueDataCatalogConfiguration object

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.

MonitoringConfiguration object

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

1 nested properties
LogLevel string | Aws_CF_FunctionString

The verbosity of the CloudWatch Logs for an application. You can set it to INFO, WARN, ERROR, or DEBUG.

DeployAsApplicationConfiguration object

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

1 nested properties
S3ContentLocation object required

The base location of the Amazon Data Analytics application.

CustomArtifactsConfiguration CustomArtifactConfiguration[]

A list of CustomArtifactConfiguration objects.

maxItems=50
VpcConfigurations VpcConfiguration[]

The array of descriptions of VPC configurations available to the application.

maxItems=1
ApplicationDescription string | Aws_CF_FunctionString

The description of the application.

ApplicationMode string | Aws_CF_FunctionString

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

ApplicationName string | Aws_CF_FunctionString

The name of the application.

RunConfiguration object

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.

2 nested properties
ApplicationRestoreConfiguration object

Describes the restore behavior of a restarting application.

2 nested properties
ApplicationRestoreType string | Aws_CF_FunctionString required

Specifies how the application should be restored.

SnapshotName string | Aws_CF_FunctionString

The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

FlinkRunConfiguration object

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

1 nested properties
AllowNonRestoredState boolean

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.

ApplicationMaintenanceConfiguration object

Describes the maintenance configuration for the application.

1 nested properties
ApplicationMaintenanceWindowStartTime string | Aws_CF_FunctionString required

The start time for the maintenance window.

Tags Tag[]

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

minItems=1maxItems=50

Definitions

Arn string | Aws_CF_FunctionString

The Amazon Resource Name

ApplicationConfiguration object

Specifies the creation parameters for a Kinesis Data Analytics application.

ApplicationCodeConfiguration object

Describes code configuration for an application.

2 nested properties
CodeContent object required

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

3 nested properties
ZipFileContent string | Aws_CF_FunctionString

The zip-format code for a Flink-based Kinesis Data Analytics application.

S3ContentLocation object

The location of an application or a custom artifact.

TextContent string | Aws_CF_FunctionString

The text-format code for a Flink-based Kinesis Data Analytics application.

CodeContentType string | Aws_CF_FunctionString required

Specifies whether the code content is in text or zip format.

ApplicationSnapshotConfiguration object

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

1 nested properties
SnapshotsEnabled boolean required

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

EnvironmentProperties object

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

1 nested properties
PropertyGroups PropertyGroup[]

Describes the execution property groups.

maxItems=50
FlinkApplicationConfiguration object

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

3 nested properties
CheckpointConfiguration object

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.

4 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

CheckpointingEnabled boolean

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

CheckpointInterval integer

Describes the interval in milliseconds between checkpoint operations.

format=int64min=1max=9223372036854776000
MinPauseBetweenCheckpoints integer

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

format=int64min=0max=9223372036854776000
MonitoringConfiguration object

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

3 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

MetricsLevel string | Aws_CF_FunctionString

Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

LogLevel string | Aws_CF_FunctionString

Describes the verbosity of the CloudWatch Logs for an application.

ParallelismConfiguration object

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

4 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

ParallelismPerKPU integer

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

min=1
Parallelism integer

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true.

min=1
AutoScalingEnabled boolean

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

SqlApplicationConfiguration object

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

1 nested properties
Inputs Input[]

The array of Input objects describing the input streams used by the application.

maxItems=1
ZeppelinApplicationConfiguration object

The configuration of a Kinesis Data Analytics Studio notebook.

4 nested properties
CatalogConfiguration object

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.

1 nested properties
GlueDataCatalogConfiguration object

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.

MonitoringConfiguration object

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

1 nested properties
LogLevel string | Aws_CF_FunctionString

The verbosity of the CloudWatch Logs for an application. You can set it to INFO, WARN, ERROR, or DEBUG.

DeployAsApplicationConfiguration object

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

1 nested properties
S3ContentLocation object required

The base location of the Amazon Data Analytics application.

CustomArtifactsConfiguration CustomArtifactConfiguration[]

A list of CustomArtifactConfiguration objects.

maxItems=50
VpcConfigurations VpcConfiguration[]

The array of descriptions of VPC configurations available to the application.

maxItems=1
RunConfiguration object

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.

ApplicationRestoreConfiguration object

Describes the restore behavior of a restarting application.

2 nested properties
ApplicationRestoreType string | Aws_CF_FunctionString required

Specifies how the application should be restored.

SnapshotName string | Aws_CF_FunctionString

The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

FlinkRunConfiguration object

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

1 nested properties
AllowNonRestoredState boolean

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.

ApplicationRestoreConfiguration object

Describes the restore behavior of a restarting application.

ApplicationRestoreType string | Aws_CF_FunctionString required

Specifies how the application should be restored.

SnapshotName string | Aws_CF_FunctionString

The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

FlinkRunConfiguration object

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

AllowNonRestoredState boolean

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.

ApplicationCodeConfiguration object

Describes code configuration for an application.

CodeContent object required

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

3 nested properties
ZipFileContent string | Aws_CF_FunctionString

The zip-format code for a Flink-based Kinesis Data Analytics application.

S3ContentLocation object

The location of an application or a custom artifact.

3 nested properties
BucketARN string | Aws_CF_FunctionString required

The Amazon Resource Name

FileKey string | Aws_CF_FunctionString required

The file key for the object containing the application code.

ObjectVersion string | Aws_CF_FunctionString

The version of the object containing the application code.

TextContent string | Aws_CF_FunctionString

The text-format code for a Flink-based Kinesis Data Analytics application.

CodeContentType string | Aws_CF_FunctionString required

Specifies whether the code content is in text or zip format.

CodeContent object

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

ZipFileContent string | Aws_CF_FunctionString

The zip-format code for a Flink-based Kinesis Data Analytics application.

S3ContentLocation object

The location of an application or a custom artifact.

3 nested properties
BucketARN string | Aws_CF_FunctionString required

The Amazon Resource Name

FileKey string | Aws_CF_FunctionString required

The file key for the object containing the application code.

ObjectVersion string | Aws_CF_FunctionString

The version of the object containing the application code.

TextContent string | Aws_CF_FunctionString

The text-format code for a Flink-based Kinesis Data Analytics application.

S3ContentLocation object

The location of an application or a custom artifact.

BucketARN string | Aws_CF_FunctionString required

The Amazon Resource Name

FileKey string | Aws_CF_FunctionString required

The file key for the object containing the application code.

ObjectVersion string | Aws_CF_FunctionString

The version of the object containing the application code.

ApplicationSnapshotConfiguration object

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

SnapshotsEnabled boolean required

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

EnvironmentProperties object

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

PropertyGroups PropertyGroup[]

Describes the execution property groups.

maxItems=50
PropertyGroup object

Property key-value pairs passed into an application.

PropertyGroupId string | Aws_CF_FunctionString

Describes the key of an application execution property key-value pair.

PropertyMap object

Describes the value of an application execution property key-value pair.

FlinkApplicationConfiguration object

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

CheckpointConfiguration object

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.

4 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

CheckpointingEnabled boolean

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

CheckpointInterval integer

Describes the interval in milliseconds between checkpoint operations.

format=int64min=1max=9223372036854776000
MinPauseBetweenCheckpoints integer

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

format=int64min=0max=9223372036854776000
MonitoringConfiguration object

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

3 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

MetricsLevel string | Aws_CF_FunctionString

Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

LogLevel string | Aws_CF_FunctionString

Describes the verbosity of the CloudWatch Logs for an application.

ParallelismConfiguration object

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

4 nested properties
ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

ParallelismPerKPU integer

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

min=1
Parallelism integer

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true.

min=1
AutoScalingEnabled boolean

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

CheckpointConfiguration object

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.

ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

CheckpointingEnabled boolean

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

CheckpointInterval integer

Describes the interval in milliseconds between checkpoint operations.

format=int64min=1max=9223372036854776000
MinPauseBetweenCheckpoints integer

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

format=int64min=0max=9223372036854776000
MonitoringConfiguration object

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

ConfigurationType string | Aws_CF_FunctionString required

Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

MetricsLevel string | Aws_CF_FunctionString

Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

LogLevel string | Aws_CF_FunctionString

Describes the verbosity of the CloudWatch Logs for an application.

ParallelismConfiguration object

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

ConfigurationType string | Aws_CF_FunctionString required

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

ParallelismPerKPU integer

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

min=1
Parallelism integer

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true.

min=1
AutoScalingEnabled boolean

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

SqlApplicationConfiguration object

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

Inputs Input[]

The array of Input objects describing the input streams used by the application.

maxItems=1
Input object

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.

NamePrefix string | Aws_CF_FunctionString required

The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream". Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001", "MyInApplicationStream_002", and so on.

InputSchema object required

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.

3 nested properties
RecordColumns RecordColumn[] required

A list of RecordColumn objects.

maxItems=1000
RecordFormat object required

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.

2 nested properties
RecordFormatType string | Aws_CF_FunctionString required

The type of record format.

MappingParameters object

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.

RecordEncoding string | Aws_CF_FunctionString

Specifies the encoding of the records in the streaming source. For example, UTF-8.

KinesisStreamsInput object

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

1 nested properties
ResourceARN string | Aws_CF_FunctionString required

The Amazon Resource Name

KinesisFirehoseInput object

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

1 nested properties
ResourceARN string | Aws_CF_FunctionString required

The Amazon Resource Name

InputProcessingConfiguration object

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.

1 nested properties
InputLambdaProcessor object

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.

1 nested properties
ResourceARN string | Aws_CF_FunctionString required

The Amazon Resource Name

InputParallelism object

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

1 nested properties
Count integer

The number of in-application streams to create.

min=1max=64
InputSchema object

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.

RecordColumns RecordColumn[] required

A list of RecordColumn objects.

maxItems=1000
RecordFormat object required

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.

2 nested properties
RecordFormatType string | Aws_CF_FunctionString required

The type of record format.

MappingParameters object

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.

2 nested properties
CSVMappingParameters object

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"

JSONMappingParameters object

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

RecordEncoding string | Aws_CF_FunctionString

Specifies the encoding of the records in the streaming source. For example, UTF-8.

RecordColumn object

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.

Name string | Aws_CF_FunctionString required

The name of the column that is created in the in-application input stream or reference table.

SqlType string | Aws_CF_FunctionString required

The type of column created in the in-application input stream or reference table.

Mapping string | Aws_CF_FunctionString

A reference to the data element in the streaming input or the reference data source.

RecordFormat object

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.

RecordFormatType string | Aws_CF_FunctionString required

The type of record format.

MappingParameters object

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.

2 nested properties
CSVMappingParameters object

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"

2 nested properties
RecordColumnDelimiter string | Aws_CF_FunctionString required

The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

RecordRowDelimiter string | Aws_CF_FunctionString required

The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

JSONMappingParameters object

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

1 nested properties
RecordRowPath string | Aws_CF_FunctionString required

The path to the top-level parent that contains the records.

MappingParameters object

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.

CSVMappingParameters object

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"

2 nested properties
RecordColumnDelimiter string | Aws_CF_FunctionString required

The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

RecordRowDelimiter string | Aws_CF_FunctionString required

The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

JSONMappingParameters object

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

1 nested properties
RecordRowPath string | Aws_CF_FunctionString required

The path to the top-level parent that contains the records.

CSVMappingParameters object

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"

RecordColumnDelimiter string | Aws_CF_FunctionString required

The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

RecordRowDelimiter string | Aws_CF_FunctionString required

The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

JSONMappingParameters object

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

RecordRowPath string | Aws_CF_FunctionString required

The path to the top-level parent that contains the records.

KinesisStreamsInput object

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

ResourceARN string | Aws_CF_FunctionString required

The Amazon Resource Name

KinesisFirehoseInput object

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

ResourceARN string | Aws_CF_FunctionString required

The Amazon Resource Name

InputProcessingConfiguration object

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.

InputLambdaProcessor object

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.

1 nested properties
ResourceARN string | Aws_CF_FunctionString required

The Amazon Resource Name

InputLambdaProcessor object

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.

ResourceARN string | Aws_CF_FunctionString required

The Amazon Resource Name

InputParallelism object

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

Count integer

The number of in-application streams to create.

min=1max=64
ZeppelinApplicationConfiguration object

The configuration of a Kinesis Data Analytics Studio notebook.

CatalogConfiguration object

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.

1 nested properties
GlueDataCatalogConfiguration object

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.

1 nested properties
DatabaseARN string | Aws_CF_FunctionString

The Amazon Resource Name

MonitoringConfiguration object

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

1 nested properties
LogLevel string | Aws_CF_FunctionString

The verbosity of the CloudWatch Logs for an application. You can set it to INFO, WARN, ERROR, or DEBUG.

DeployAsApplicationConfiguration object

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

1 nested properties
S3ContentLocation object required

The base location of the Amazon Data Analytics application.

2 nested properties
BucketARN string | Aws_CF_FunctionString required

The Amazon Resource Name

BasePath string | Aws_CF_FunctionString

The base path for the S3 bucket.

CustomArtifactsConfiguration CustomArtifactConfiguration[]

A list of CustomArtifactConfiguration objects.

maxItems=50
CatalogConfiguration object

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.

GlueDataCatalogConfiguration object

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.

1 nested properties
DatabaseARN string | Aws_CF_FunctionString

The Amazon Resource Name

GlueDataCatalogConfiguration object

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.

DatabaseARN string | Aws_CF_FunctionString

The Amazon Resource Name

ZeppelinMonitoringConfiguration object

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

LogLevel string | Aws_CF_FunctionString

The verbosity of the CloudWatch Logs for an application. You can set it to INFO, WARN, ERROR, or DEBUG.

DeployAsApplicationConfiguration object

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

S3ContentLocation object required

The base location of the Amazon Data Analytics application.

2 nested properties
BucketARN string | Aws_CF_FunctionString required

The Amazon Resource Name

BasePath string | Aws_CF_FunctionString

The base path for the S3 bucket.

S3ContentBaseLocation object

The base location of the Amazon Data Analytics application.

BucketARN string | Aws_CF_FunctionString required

The Amazon Resource Name

BasePath string | Aws_CF_FunctionString

The base path for the S3 bucket.

CustomArtifactsConfiguration CustomArtifactConfiguration[]

A list of CustomArtifactConfiguration objects.

CustomArtifactConfiguration object

The configuration of connectors and user-defined functions.

ArtifactType string | Aws_CF_FunctionString required

Set this to either UDF or DEPENDENCY_JAR. UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

MavenReference object

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

3 nested properties
ArtifactId string | Aws_CF_FunctionString required

The artifact ID of the Maven reference.

GroupId string | Aws_CF_FunctionString required

The group ID of the Maven reference.

Version string | Aws_CF_FunctionString required

The version of the Maven reference.

S3ContentLocation object

The location of an application or a custom artifact.

3 nested properties
BucketARN string | Aws_CF_FunctionString required

The Amazon Resource Name

FileKey string | Aws_CF_FunctionString required

The file key for the object containing the application code.

ObjectVersion string | Aws_CF_FunctionString

The version of the object containing the application code.

MavenReference object

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

ArtifactId string | Aws_CF_FunctionString required

The artifact ID of the Maven reference.

GroupId string | Aws_CF_FunctionString required

The group ID of the Maven reference.

Version string | Aws_CF_FunctionString required

The version of the Maven reference.

VpcConfigurations VpcConfiguration[]

The array of descriptions of VPC configurations available to the application.

VpcConfiguration object

Describes the parameters of a VPC used by the application.

SecurityGroupIds string[] required

The array of SecurityGroup IDs used by the VPC configuration.

minItems=1maxItems=5
SubnetIds string[] required

The array of Subnet IDs used by the VPC configuration.

minItems=1maxItems=16
ApplicationMaintenanceConfiguration object

Describes the maintenance configuration for the application.

ApplicationMaintenanceWindowStartTime string | Aws_CF_FunctionString required

The start time for the maintenance window.

Tag object

A key-value pair that identifies an application.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that's 0 to 256 characters in length.