Class CfnApplication
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kinesisanalyticsv2.CfnApplication
- All Implemented Interfaces:
IInspectable,IEnvironmentAware,IApplicationRef,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-05T22:26:38.907Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable, IApplicationRef, ITaggable
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())
.applicationEncryptionConfiguration(ApplicationEncryptionConfigurationProperty.builder()
.keyType("keyType")
// the properties below are optional
.keyId("keyId")
.build())
.applicationSnapshotConfiguration(ApplicationSnapshotConfigurationProperty.builder()
.snapshotsEnabled(false)
.build())
.applicationSystemRollbackConfiguration(ApplicationSystemRollbackConfigurationProperty.builder()
.rollbackEnabled(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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceDescribes code configuration for an application.static interfaceSpecifies the creation parameters for a Managed Service for Apache Flink application.static interfaceSpecifies the configuration to manage encryption at rest.static interfaceSpecifies the maintenance configuration for a AKAlong .static interfaceSpecifies the method and snapshot to use when restarting an application using previously saved application state.static interfaceDescribes whether snapshots are enabled for a Managed Service for Apache Flink application.static interfaceDescribes the system rollback configuration for a Managed Service for Apache Flink application.static final classA fluent builder forCfnApplication.static interfaceThe configuration parameters for the default Amazon Glue database.static interfaceDescribes an application's checkpointing configuration.static interfaceSpecifies either the application code, or the location of the application code, for a Managed Service for Apache Flink application.static interfaceFor a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV.static interfaceThe configuration of connectors and user-defined functions.static interfaceThe information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.static interfaceDescribes execution properties for a Managed Service for Apache Flink application.static interfaceDescribes configuration parameters for a Managed Service for Apache Flink application or a Studio notebook.static interfaceDescribes the starting parameters for a Managed Service for Apache Flink application.static interfaceThe 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 interfaceAn 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 interfaceFor a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.static interfaceFor 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 interfaceWhen 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 interfaceFor 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 interfaceFor a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.static interfaceFor a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source.static interfaceIdentifies a Kinesis data stream as the streaming source.static interfaceWhen 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 interfaceThe information required to specify a Maven reference.static interfaceDescribes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application.static interfaceDescribes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.static interfaceProperty key-value pairs passed into an application.static interfaceFor 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 interfaceFor 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 interfaceDescribes the starting parameters for an Managed Service for Apache Flink application.static interfaceThe base location of the Amazon Data Analytics application.static interfaceThe location of an application or a custom artifact.static interfaceDescribes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.static interfaceDescribes the parameters of a VPC used by the application.static interfaceThe configuration of a Kinesis Data Analytics Studio notebook.static interfaceDescribes 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.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.kinesisanalyticsv2.IApplicationRef
IApplicationRef.Jsii$Default, IApplicationRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnApplication(software.amazon.jsii.JsiiObjectRef objRef) CfnApplication(software.constructs.Construct scope, String id, CfnApplicationProps props) Create a newAWS::KinesisAnalyticsV2::Application. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringarnForApplication(IApplicationRef resource) static IApplicationReffromApplicationName(software.constructs.Construct scope, String id, String applicationName) Creates a new IApplicationRef from a applicationName.Use this parameter to configure the application.The description of the application.Specifies the maintenance window parameters for a Kinesis Data Analytics application.To create a Kinesis Data Analytics Studio notebook, you must set the mode toINTERACTIVE.The name of the application.A reference to a Application resource.Describes the starting parameters for an Managed Service for Apache Flink application.The runtime environment for the application.Specifies the IAM role that the application uses to access external resources.getTags()Tag Manager which manages the tags for this resource.A list of one or more tags to assign to the application.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.static BooleanChecks whether the given object is a CfnApplication.renderProperties(Map<String, Object> props) voidUse this parameter to configure the application.voidUse this parameter to configure the application.voidsetApplicationDescription(String value) The description of the application.voidSpecifies the maintenance window parameters for a Kinesis Data Analytics application.voidsetApplicationMaintenanceConfiguration(CfnApplication.ApplicationMaintenanceConfigurationProperty value) Specifies the maintenance window parameters for a Kinesis Data Analytics application.voidsetApplicationMode(String value) To create a Kinesis Data Analytics Studio notebook, you must set the mode toINTERACTIVE.voidsetApplicationName(String value) The name of the application.voidsetRunConfiguration(IResolvable value) Describes the starting parameters for an Managed Service for Apache Flink application.voidDescribes the starting parameters for an Managed Service for Apache Flink application.voidsetRuntimeEnvironment(String value) The runtime environment for the application.voidsetServiceExecutionRole(String value) Specifies the IAM role that the application uses to access external resources.voidsetTagsRaw(List<CfnTag> value) A list of one or more tags to assign to the application.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props) Create a newAWS::KinesisAnalyticsV2::Application.- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
arnForApplication
@Stability(Stable) @NotNull public static String arnForApplication(@NotNull IApplicationRef resource) - Parameters:
resource- This parameter is required.
-
fromApplicationName
@Stability(Stable) @NotNull public static IApplicationRef fromApplicationName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String applicationName) Creates a new IApplicationRef from a applicationName.- Parameters:
scope- This parameter is required.id- This parameter is required.applicationName- This parameter is required.
-
isCfnApplication
Checks whether the given object is a CfnApplication.- Parameters:
x- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getApplicationRef
A reference to a Application resource.- Specified by:
getApplicationRefin interfaceIApplicationRef
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getRuntimeEnvironment
The runtime environment for the application. -
setRuntimeEnvironment
The runtime environment for the application. -
getServiceExecutionRole
Specifies the IAM role that the application uses to access external resources. -
setServiceExecutionRole
Specifies the IAM role that the application uses to access external resources. -
getApplicationConfiguration
Use this parameter to configure the application.Returns union: either
IResolvableorCfnApplication.ApplicationConfigurationProperty -
setApplicationConfiguration
Use this parameter to configure the application. -
setApplicationConfiguration
@Stability(Stable) public void setApplicationConfiguration(@Nullable CfnApplication.ApplicationConfigurationProperty value) Use this parameter to configure the application. -
getApplicationDescription
The description of the application. -
setApplicationDescription
The description of the application. -
getApplicationMaintenanceConfiguration
Specifies the maintenance window parameters for a Kinesis Data Analytics application.Returns union: either
IResolvableorCfnApplication.ApplicationMaintenanceConfigurationProperty -
setApplicationMaintenanceConfiguration
Specifies the maintenance window parameters for a Kinesis Data Analytics application. -
setApplicationMaintenanceConfiguration
@Stability(Stable) public void setApplicationMaintenanceConfiguration(@Nullable CfnApplication.ApplicationMaintenanceConfigurationProperty value) Specifies the maintenance window parameters for a Kinesis Data Analytics application. -
getApplicationMode
To create a Kinesis Data Analytics Studio notebook, you must set the mode toINTERACTIVE. -
setApplicationMode
To create a Kinesis Data Analytics Studio notebook, you must set the mode toINTERACTIVE. -
getApplicationName
The name of the application. -
setApplicationName
The name of the application. -
getRunConfiguration
Describes the starting parameters for an Managed Service for Apache Flink application.Returns union: either
IResolvableorCfnApplication.RunConfigurationProperty -
setRunConfiguration
Describes the starting parameters for an Managed Service for Apache Flink application. -
setRunConfiguration
@Stability(Stable) public void setRunConfiguration(@Nullable CfnApplication.RunConfigurationProperty value) Describes the starting parameters for an Managed Service for Apache Flink application. -
getTagsRaw
A list of one or more tags to assign to the application. -
setTagsRaw
A list of one or more tags to assign to the application.
-