Package software.amazon.awscdk.services.kinesisanalyticsv2

Class CfnApplication

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.kinesisanalyticsv2.CfnApplication

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:58.324Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation AWS::KinesisAnalyticsV2::Application.

Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application .

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.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .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	Class	Description
static interface	CfnApplication.ApplicationCodeConfigurationProperty	Describes code configuration for an application.
static interface	CfnApplication.ApplicationConfigurationProperty	Specifies the creation parameters for a Kinesis Data Analytics application.
static interface	CfnApplication.ApplicationMaintenanceConfigurationProperty	Specifies the maintence window parameters for a Kinesis Data Analytics application.
static interface	CfnApplication.ApplicationRestoreConfigurationProperty	Specifies the method and snapshot to use when restarting an application using previously saved application state.
static interface	CfnApplication.ApplicationSnapshotConfigurationProperty	Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
static final class	CfnApplication.Builder	A fluent builder for CfnApplication.
static interface	CfnApplication.CatalogConfigurationProperty	The configuration parameters for the default Amazon Glue database.
static interface	CfnApplication.CheckpointConfigurationProperty	Describes an application's checkpointing configuration.
static interface	CfnApplication.CodeContentProperty	Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.
static interface	CfnApplication.CSVMappingParametersProperty	For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV.
static interface	CfnApplication.CustomArtifactConfigurationProperty	The configuration of connectors and user-defined functions.
static interface	CfnApplication.DeployAsApplicationConfigurationProperty	The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.
static interface	CfnApplication.EnvironmentPropertiesProperty	Describes execution properties for a Flink-based Kinesis Data Analytics application.
static interface	CfnApplication.FlinkApplicationConfigurationProperty	Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.
static interface	CfnApplication.FlinkRunConfigurationProperty	Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
static interface	CfnApplication.GlueDataCatalogConfigurationProperty	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.
static interface	CfnApplication.InputLambdaProcessorProperty	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.
static interface	CfnApplication.InputParallelismProperty	For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.
static interface	CfnApplication.InputProcessingConfigurationProperty	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.
static interface	CfnApplication.InputProperty	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.
static interface	CfnApplication.InputSchemaProperty	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.
static interface	CfnApplication.JSONMappingParametersProperty	For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
static interface	CfnApplication.KinesisFirehoseInputProperty	For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source.
static interface	CfnApplication.KinesisStreamsInputProperty	Identifies a Kinesis data stream as the streaming source.
static interface	CfnApplication.MappingParametersProperty	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.
static interface	CfnApplication.MavenReferenceProperty	The information required to specify a Maven reference.
static interface	CfnApplication.MonitoringConfigurationProperty	Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application.
static interface	CfnApplication.ParallelismConfigurationProperty	Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.
static interface	CfnApplication.PropertyGroupProperty	Property key-value pairs passed into an application.
static interface	CfnApplication.RecordColumnProperty	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.
static interface	CfnApplication.RecordFormatProperty	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.
static interface	CfnApplication.RunConfigurationProperty	Describes the starting parameters for an Kinesis Data Analytics application.
static interface	CfnApplication.S3ContentBaseLocationProperty	The base location of the Amazon Data Analytics application.
static interface	CfnApplication.S3ContentLocationProperty	The location of an application or a custom artifact.
static interface	CfnApplication.SqlApplicationConfigurationProperty	Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
static interface	CfnApplication.VpcConfigurationProperty	Describes the parameters of a VPC used by the application.
static interface	CfnApplication.ZeppelinApplicationConfigurationProperty	The configuration of a Kinesis Data Analytics Studio notebook.
static interface	CfnApplication.ZeppelinMonitoringConfigurationProperty	Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnApplication(Construct scope, String id, CfnApplicationProps props)	Create a new AWS::KinesisAnalyticsV2::Application.
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
Object	getApplicationConfiguration()	Use this parameter to configure the application.
String	getApplicationDescription()	The description of the application.
Object	getApplicationMaintenanceConfiguration()	AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.
String	getApplicationMode()	To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE .
String	getApplicationName()	The name of the application.
protected Map<String,Object>	getCfnProperties()
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.
TagManager	getTags()	A list of one or more tags to assign to the application.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationConfiguration(IResolvable value)	Use this parameter to configure the application.
void	setApplicationConfiguration(CfnApplication.ApplicationConfigurationProperty value)	Use this parameter to configure the application.
void	setApplicationDescription(String value)	The description of the application.
void	setApplicationMaintenanceConfiguration(IResolvable value)	AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.
void	setApplicationMaintenanceConfiguration(CfnApplication.ApplicationMaintenanceConfigurationProperty value)	AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.
void	setApplicationMode(String value)	To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE .
void	setApplicationName(String value)	The name of the application.
void	setRunConfiguration(IResolvable value)	AWS::KinesisAnalyticsV2::Application.RunConfiguration.
void	setRunConfiguration(CfnApplication.RunConfigurationProperty value)	AWS::KinesisAnalyticsV2::Application.RunConfiguration.
void	setRuntimeEnvironment(String value)	The runtime environment for the application.
void	setServiceExecutionRole(String value)	Specifies the IAM role that the application uses to access external resources.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnApplication

protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

CfnApplication

protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApplication

@Stability(Stable)
public CfnApplication(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnApplicationProps props)

Create a new AWS::KinesisAnalyticsV2::Application.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager 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.

getRuntimeEnvironment

@Stability(Stable)
@NotNull
public String getRuntimeEnvironment()

The runtime environment for the application.

setRuntimeEnvironment

@Stability(Stable)
public void setRuntimeEnvironment(@NotNull
 String value)

The runtime environment for the application.

getServiceExecutionRole

@Stability(Stable)
@NotNull
public String getServiceExecutionRole()

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

setServiceExecutionRole

@Stability(Stable)
public void setServiceExecutionRole(@NotNull
 String value)

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

getApplicationConfiguration

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

Use this parameter to configure the application.

setApplicationConfiguration

@Stability(Stable)
public void setApplicationConfiguration(@Nullable
 CfnApplication.ApplicationConfigurationProperty value)

Use this parameter to configure the application.

setApplicationConfiguration

@Stability(Stable)
public void setApplicationConfiguration(@Nullable
 IResolvable value)

Use this parameter to configure the application.

getApplicationDescription

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

The description of the application.

setApplicationDescription

@Stability(Stable)
public void setApplicationDescription(@Nullable
 String value)

The description of the application.

getApplicationMaintenanceConfiguration

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

AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.

setApplicationMaintenanceConfiguration

@Stability(Stable)
public void setApplicationMaintenanceConfiguration(@Nullable
 IResolvable value)

AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.

setApplicationMaintenanceConfiguration

@Stability(Stable)
public void setApplicationMaintenanceConfiguration(@Nullable
 CfnApplication.ApplicationMaintenanceConfigurationProperty value)

AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration.

getApplicationMode

@Stability(Stable)
@Nullable
public 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.

setApplicationMode

@Stability(Stable)
public void setApplicationMode(@Nullable
 String value)

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
public String getApplicationName()

The name of the application.

setApplicationName

@Stability(Stable)
public void setApplicationName(@Nullable
 String value)

The name of the application.

getRunConfiguration

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

AWS::KinesisAnalyticsV2::Application.RunConfiguration.

setRunConfiguration

@Stability(Stable)
public void setRunConfiguration(@Nullable
 IResolvable value)

AWS::KinesisAnalyticsV2::Application.RunConfiguration.

setRunConfiguration

@Stability(Stable)
public void setRunConfiguration(@Nullable
 CfnApplication.RunConfigurationProperty value)

AWS::KinesisAnalyticsV2::Application.RunConfiguration.