CfnApplicationProps

class aws_cdk.aws_kinesisanalyticsv2.CfnApplicationProps(*, runtime_environment, service_execution_role, application_configuration=None, application_description=None, application_maintenance_configuration=None, application_mode=None, application_name=None, run_configuration=None, tags=None)

Bases: object

Properties for defining a CfnApplication.

Parameters:

runtime_environment (str) – The runtime environment for the application.
service_execution_role (str) – Specifies the IAM role that the application uses to access external resources.
application_configuration (Union[ApplicationConfigurationProperty, Dict[str, Any], IResolvable, None]) – Use this parameter to configure the application.
application_description (Optional[str]) – The description of the application.
application_maintenance_configuration (Union[IResolvable, ApplicationMaintenanceConfigurationProperty, Dict[str, Any], None]) – AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.
application_mode (Optional[str]) – 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.
application_name (Optional[str]) – The name of the application.
run_configuration (Union[IResolvable, RunConfigurationProperty, Dict[str, Any], None]) – AWS::KinesisAnalyticsV2::Application.RunConfiguration.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_kinesisanalyticsv2 as kinesisanalyticsv2

cfn_application_props = kinesisanalyticsv2.CfnApplicationProps(
    runtime_environment="runtimeEnvironment",
    service_execution_role="serviceExecutionRole",

    # the properties below are optional
    application_configuration=kinesisanalyticsv2.CfnApplication.ApplicationConfigurationProperty(
        application_code_configuration=kinesisanalyticsv2.CfnApplication.ApplicationCodeConfigurationProperty(
            code_content=kinesisanalyticsv2.CfnApplication.CodeContentProperty(
                s3_content_location=kinesisanalyticsv2.CfnApplication.S3ContentLocationProperty(
                    bucket_arn="bucketArn",
                    file_key="fileKey",

                    # the properties below are optional
                    object_version="objectVersion"
                ),
                text_content="textContent",
                zip_file_content="zipFileContent"
            ),
            code_content_type="codeContentType"
        ),
        application_snapshot_configuration=kinesisanalyticsv2.CfnApplication.ApplicationSnapshotConfigurationProperty(
            snapshots_enabled=False
        ),
        environment_properties=kinesisanalyticsv2.CfnApplication.EnvironmentPropertiesProperty(
            property_groups=[kinesisanalyticsv2.CfnApplication.PropertyGroupProperty(
                property_group_id="propertyGroupId",
                property_map={
                    "property_map_key": "propertyMap"
                }
            )]
        ),
        flink_application_configuration=kinesisanalyticsv2.CfnApplication.FlinkApplicationConfigurationProperty(
            checkpoint_configuration=kinesisanalyticsv2.CfnApplication.CheckpointConfigurationProperty(
                configuration_type="configurationType",

                # the properties below are optional
                checkpointing_enabled=False,
                checkpoint_interval=123,
                min_pause_between_checkpoints=123
            ),
            monitoring_configuration=kinesisanalyticsv2.CfnApplication.MonitoringConfigurationProperty(
                configuration_type="configurationType",

                # the properties below are optional
                log_level="logLevel",
                metrics_level="metricsLevel"
            ),
            parallelism_configuration=kinesisanalyticsv2.CfnApplication.ParallelismConfigurationProperty(
                configuration_type="configurationType",

                # the properties below are optional
                auto_scaling_enabled=False,
                parallelism=123,
                parallelism_per_kpu=123
            )
        ),
        sql_application_configuration=kinesisanalyticsv2.CfnApplication.SqlApplicationConfigurationProperty(
            inputs=[kinesisanalyticsv2.CfnApplication.InputProperty(
                input_schema=kinesisanalyticsv2.CfnApplication.InputSchemaProperty(
                    record_columns=[kinesisanalyticsv2.CfnApplication.RecordColumnProperty(
                        name="name",
                        sql_type="sqlType",

                        # the properties below are optional
                        mapping="mapping"
                    )],
                    record_format=kinesisanalyticsv2.CfnApplication.RecordFormatProperty(
                        record_format_type="recordFormatType",

                        # the properties below are optional
                        mapping_parameters=kinesisanalyticsv2.CfnApplication.MappingParametersProperty(
                            csv_mapping_parameters=kinesisanalyticsv2.CfnApplication.CSVMappingParametersProperty(
                                record_column_delimiter="recordColumnDelimiter",
                                record_row_delimiter="recordRowDelimiter"
                            ),
                            json_mapping_parameters=kinesisanalyticsv2.CfnApplication.JSONMappingParametersProperty(
                                record_row_path="recordRowPath"
                            )
                        )
                    ),

                    # the properties below are optional
                    record_encoding="recordEncoding"
                ),
                name_prefix="namePrefix",

                # the properties below are optional
                input_parallelism=kinesisanalyticsv2.CfnApplication.InputParallelismProperty(
                    count=123
                ),
                input_processing_configuration=kinesisanalyticsv2.CfnApplication.InputProcessingConfigurationProperty(
                    input_lambda_processor=kinesisanalyticsv2.CfnApplication.InputLambdaProcessorProperty(
                        resource_arn="resourceArn"
                    )
                ),
                kinesis_firehose_input=kinesisanalyticsv2.CfnApplication.KinesisFirehoseInputProperty(
                    resource_arn="resourceArn"
                ),
                kinesis_streams_input=kinesisanalyticsv2.CfnApplication.KinesisStreamsInputProperty(
                    resource_arn="resourceArn"
                )
            )]
        ),
        vpc_configurations=[kinesisanalyticsv2.CfnApplication.VpcConfigurationProperty(
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )],
        zeppelin_application_configuration=kinesisanalyticsv2.CfnApplication.ZeppelinApplicationConfigurationProperty(
            catalog_configuration=kinesisanalyticsv2.CfnApplication.CatalogConfigurationProperty(
                glue_data_catalog_configuration=kinesisanalyticsv2.CfnApplication.GlueDataCatalogConfigurationProperty(
                    database_arn="databaseArn"
                )
            ),
            custom_artifacts_configuration=[kinesisanalyticsv2.CfnApplication.CustomArtifactConfigurationProperty(
                artifact_type="artifactType",

                # the properties below are optional
                maven_reference=kinesisanalyticsv2.CfnApplication.MavenReferenceProperty(
                    artifact_id="artifactId",
                    group_id="groupId",
                    version="version"
                ),
                s3_content_location=kinesisanalyticsv2.CfnApplication.S3ContentLocationProperty(
                    bucket_arn="bucketArn",
                    file_key="fileKey",

                    # the properties below are optional
                    object_version="objectVersion"
                )
            )],
            deploy_as_application_configuration=kinesisanalyticsv2.CfnApplication.DeployAsApplicationConfigurationProperty(
                s3_content_location=kinesisanalyticsv2.CfnApplication.S3ContentBaseLocationProperty(
                    bucket_arn="bucketArn",

                    # the properties below are optional
                    base_path="basePath"
                )
            ),
            monitoring_configuration=kinesisanalyticsv2.CfnApplication.ZeppelinMonitoringConfigurationProperty(
                log_level="logLevel"
            )
        )
    ),
    application_description="applicationDescription",
    application_maintenance_configuration=kinesisanalyticsv2.CfnApplication.ApplicationMaintenanceConfigurationProperty(
        application_maintenance_window_start_time="applicationMaintenanceWindowStartTime"
    ),
    application_mode="applicationMode",
    application_name="applicationName",
    run_configuration=kinesisanalyticsv2.CfnApplication.RunConfigurationProperty(
        application_restore_configuration=kinesisanalyticsv2.CfnApplication.ApplicationRestoreConfigurationProperty(
            application_restore_type="applicationRestoreType",

            # the properties below are optional
            snapshot_name="snapshotName"
        ),
        flink_run_configuration=kinesisanalyticsv2.CfnApplication.FlinkRunConfigurationProperty(
            allow_non_restored_state=False
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

application_configuration

Use this parameter to configure the application.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationconfiguration

application_description

The description of the application.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationdescription

application_maintenance_configuration

AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationmaintenanceconfiguration

application_mode

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationmode

application_name

The name of the application.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-applicationname

run_configuration

AWS::KinesisAnalyticsV2::Application.RunConfiguration.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-runconfiguration

runtime_environment

The runtime environment for the application.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-runtimeenvironment

service_execution_role

Specifies the IAM role that the application uses to access external resources.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-serviceexecutionrole

tags

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-application.html#cfn-kinesisanalyticsv2-application-tags