Package software.amazon.awscdk.services.kinesisanalyticsv2

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:58.370Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplication.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisanalyticsv2.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .runtimeEnvironment("runtimeEnvironment")
         .serviceExecutionRole("serviceExecutionRole")
         // the properties below are optional
         .applicationConfiguration(ApplicationConfigurationProperty.builder()
                 .applicationCodeConfiguration(ApplicationCodeConfigurationProperty.builder()
                         .codeContent(CodeContentProperty.builder()
                                 .s3ContentLocation(S3ContentLocationProperty.builder()
                                         .bucketArn("bucketArn")
                                         .fileKey("fileKey")
                                         // the properties below are optional
                                         .objectVersion("objectVersion")
                                         .build())
                                 .textContent("textContent")
                                 .zipFileContent("zipFileContent")
                                 .build())
                         .codeContentType("codeContentType")
                         .build())
                 .applicationSnapshotConfiguration(ApplicationSnapshotConfigurationProperty.builder()
                         .snapshotsEnabled(false)
                         .build())
                 .environmentProperties(EnvironmentPropertiesProperty.builder()
                         .propertyGroups(List.of(PropertyGroupProperty.builder()
                                 .propertyGroupId("propertyGroupId")
                                 .propertyMap(Map.of(
                                         "propertyMapKey", "propertyMap"))
                                 .build()))
                         .build())
                 .flinkApplicationConfiguration(FlinkApplicationConfigurationProperty.builder()
                         .checkpointConfiguration(CheckpointConfigurationProperty.builder()
                                 .configurationType("configurationType")
                                 // the properties below are optional
                                 .checkpointingEnabled(false)
                                 .checkpointInterval(123)
                                 .minPauseBetweenCheckpoints(123)
                                 .build())
                         .monitoringConfiguration(MonitoringConfigurationProperty.builder()
                                 .configurationType("configurationType")
                                 // the properties below are optional
                                 .logLevel("logLevel")
                                 .metricsLevel("metricsLevel")
                                 .build())
                         .parallelismConfiguration(ParallelismConfigurationProperty.builder()
                                 .configurationType("configurationType")
                                 // the properties below are optional
                                 .autoScalingEnabled(false)
                                 .parallelism(123)
                                 .parallelismPerKpu(123)
                                 .build())
                         .build())
                 .sqlApplicationConfiguration(SqlApplicationConfigurationProperty.builder()
                         .inputs(List.of(InputProperty.builder()
                                 .inputSchema(InputSchemaProperty.builder()
                                         .recordColumns(List.of(RecordColumnProperty.builder()
                                                 .name("name")
                                                 .sqlType("sqlType")
                                                 // the properties below are optional
                                                 .mapping("mapping")
                                                 .build()))
                                         .recordFormat(RecordFormatProperty.builder()
                                                 .recordFormatType("recordFormatType")
                                                 // the properties below are optional
                                                 .mappingParameters(MappingParametersProperty.builder()
                                                         .csvMappingParameters(CSVMappingParametersProperty.builder()
                                                                 .recordColumnDelimiter("recordColumnDelimiter")
                                                                 .recordRowDelimiter("recordRowDelimiter")
                                                                 .build())
                                                         .jsonMappingParameters(JSONMappingParametersProperty.builder()
                                                                 .recordRowPath("recordRowPath")
                                                                 .build())
                                                         .build())
                                                 .build())
                                         // the properties below are optional
                                         .recordEncoding("recordEncoding")
                                         .build())
                                 .namePrefix("namePrefix")
                                 // the properties below are optional
                                 .inputParallelism(InputParallelismProperty.builder()
                                         .count(123)
                                         .build())
                                 .inputProcessingConfiguration(InputProcessingConfigurationProperty.builder()
                                         .inputLambdaProcessor(InputLambdaProcessorProperty.builder()
                                                 .resourceArn("resourceArn")
                                                 .build())
                                         .build())
                                 .kinesisFirehoseInput(KinesisFirehoseInputProperty.builder()
                                         .resourceArn("resourceArn")
                                         .build())
                                 .kinesisStreamsInput(KinesisStreamsInputProperty.builder()
                                         .resourceArn("resourceArn")
                                         .build())
                                 .build()))
                         .build())
                 .vpcConfigurations(List.of(VpcConfigurationProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnetIds(List.of("subnetIds"))
                         .build()))
                 .zeppelinApplicationConfiguration(ZeppelinApplicationConfigurationProperty.builder()
                         .catalogConfiguration(CatalogConfigurationProperty.builder()
                                 .glueDataCatalogConfiguration(GlueDataCatalogConfigurationProperty.builder()
                                         .databaseArn("databaseArn")
                                         .build())
                                 .build())
                         .customArtifactsConfiguration(List.of(CustomArtifactConfigurationProperty.builder()
                                 .artifactType("artifactType")
                                 // the properties below are optional
                                 .mavenReference(MavenReferenceProperty.builder()
                                         .artifactId("artifactId")
                                         .groupId("groupId")
                                         .version("version")
                                         .build())
                                 .s3ContentLocation(S3ContentLocationProperty.builder()
                                         .bucketArn("bucketArn")
                                         .fileKey("fileKey")
                                         // the properties below are optional
                                         .objectVersion("objectVersion")
                                         .build())
                                 .build()))
                         .deployAsApplicationConfiguration(DeployAsApplicationConfigurationProperty.builder()
                                 .s3ContentLocation(S3ContentBaseLocationProperty.builder()
                                         .bucketArn("bucketArn")
                                         // the properties below are optional
                                         .basePath("basePath")
                                         .build())
                                 .build())
                         .monitoringConfiguration(ZeppelinMonitoringConfigurationProperty.builder()
                                 .logLevel("logLevel")
                                 .build())
                         .build())
                 .build())
         .applicationDescription("applicationDescription")
         .applicationMaintenanceConfiguration(ApplicationMaintenanceConfigurationProperty.builder()
                 .applicationMaintenanceWindowStartTime("applicationMaintenanceWindowStartTime")
                 .build())
         .applicationMode("applicationMode")
         .applicationName("applicationName")
         .runConfiguration(RunConfigurationProperty.builder()
                 .applicationRestoreConfiguration(ApplicationRestoreConfigurationProperty.builder()
                         .applicationRestoreType("applicationRestoreType")
                         // the properties below are optional
                         .snapshotName("snapshotName")
                         .build())
                 .flinkRunConfiguration(FlinkRunConfigurationProperty.builder()
                         .allowNonRestoredState(false)
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplicationProps.Builder	A builder for CfnApplicationProps
static final class	CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
default Object	getApplicationConfiguration()	Use this parameter to configure the application.
default String	getApplicationDescription()	The description of the application.
default Object	getApplicationMaintenanceConfiguration()	AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.
default String	getApplicationMode()	To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE .
default String	getApplicationName()	The name of the application.
default Object	getRunConfiguration()	AWS::KinesisAnalyticsV2::Application.RunConfiguration.
String	getRuntimeEnvironment()	The runtime environment for the application.
String	getServiceExecutionRole()	Specifies the IAM role that the application uses to access external resources.
default List<CfnTag>	getTags()	A list of one or more tags to assign to the application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRuntimeEnvironment

@Stability(Stable)
@NotNull
String getRuntimeEnvironment()

The runtime environment for the application.

getServiceExecutionRole

@Stability(Stable)
@NotNull
String getServiceExecutionRole()

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

getApplicationConfiguration

@Stability(Stable)
@Nullable
default Object getApplicationConfiguration()

Use this parameter to configure the application.

getApplicationDescription

@Stability(Stable)
@Nullable
default String getApplicationDescription()

The description of the application.

getApplicationMaintenanceConfiguration

@Stability(Stable)
@Nullable
default Object getApplicationMaintenanceConfiguration()

AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.

getApplicationMode

@Stability(Stable)
@Nullable
default String getApplicationMode()

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.

getApplicationName

@Stability(Stable)
@Nullable
default String getApplicationName()

The name of the application.

getRunConfiguration

@Stability(Stable)
@Nullable
default Object getRunConfiguration()

AWS::KinesisAnalyticsV2::Application.RunConfiguration.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

builder

@Stability(Stable)
static CfnApplicationProps.Builder builder()

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps