interface CfnApplicationProps

Language	Type name
.NET	Amazon.CDK.AWS.KinesisAnalyticsV2.CfnApplicationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awskinesisanalyticsv2#CfnApplicationProps
Java	software.amazon.awscdk.services.kinesisanalyticsv2.CfnApplicationProps
Python	aws_cdk.aws_kinesisanalyticsv2.CfnApplicationProps
TypeScript	aws-cdk-lib » aws_kinesisanalyticsv2 » CfnApplicationProps

Properties for defining a CfnApplication.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisanalyticsv2 as kinesisanalyticsv2 } from 'aws-cdk-lib';
const cfnApplicationProps: kinesisanalyticsv2.CfnApplicationProps = {
  runtimeEnvironment: 'runtimeEnvironment',
  serviceExecutionRole: 'serviceExecutionRole',

  // the properties below are optional
  applicationConfiguration: {
    applicationCodeConfiguration: {
      codeContent: {
        s3ContentLocation: {
          bucketArn: 'bucketArn',
          fileKey: 'fileKey',

          // the properties below are optional
          objectVersion: 'objectVersion',
        },
        textContent: 'textContent',
        zipFileContent: 'zipFileContent',
      },
      codeContentType: 'codeContentType',
    },
    applicationEncryptionConfiguration: {
      keyType: 'keyType',

      // the properties below are optional
      keyId: 'keyId',
    },
    applicationSnapshotConfiguration: {
      snapshotsEnabled: false,
    },
    applicationSystemRollbackConfiguration: {
      rollbackEnabled: false,
    },
    environmentProperties: {
      propertyGroups: [{
        propertyGroupId: 'propertyGroupId',
        propertyMap: {
          propertyMapKey: 'propertyMap',
        },
      }],
    },
    flinkApplicationConfiguration: {
      checkpointConfiguration: {
        configurationType: 'configurationType',

        // the properties below are optional
        checkpointingEnabled: false,
        checkpointInterval: 123,
        minPauseBetweenCheckpoints: 123,
      },
      monitoringConfiguration: {
        configurationType: 'configurationType',

        // the properties below are optional
        logLevel: 'logLevel',
        metricsLevel: 'metricsLevel',
      },
      parallelismConfiguration: {
        configurationType: 'configurationType',

        // the properties below are optional
        autoScalingEnabled: false,
        parallelism: 123,
        parallelismPerKpu: 123,
      },
    },
    sqlApplicationConfiguration: {
      inputs: [{
        inputSchema: {
          recordColumns: [{
            name: 'name',
            sqlType: 'sqlType',

            // the properties below are optional
            mapping: 'mapping',
          }],
          recordFormat: {
            recordFormatType: 'recordFormatType',

            // the properties below are optional
            mappingParameters: {
              csvMappingParameters: {
                recordColumnDelimiter: 'recordColumnDelimiter',
                recordRowDelimiter: 'recordRowDelimiter',
              },
              jsonMappingParameters: {
                recordRowPath: 'recordRowPath',
              },
            },
          },

          // the properties below are optional
          recordEncoding: 'recordEncoding',
        },
        namePrefix: 'namePrefix',

        // the properties below are optional
        inputParallelism: {
          count: 123,
        },
        inputProcessingConfiguration: {
          inputLambdaProcessor: {
            resourceArn: 'resourceArn',
          },
        },
        kinesisFirehoseInput: {
          resourceArn: 'resourceArn',
        },
        kinesisStreamsInput: {
          resourceArn: 'resourceArn',
        },
      }],
    },
    vpcConfigurations: [{
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    }],
    zeppelinApplicationConfiguration: {
      catalogConfiguration: {
        glueDataCatalogConfiguration: {
          databaseArn: 'databaseArn',
        },
      },
      customArtifactsConfiguration: [{
        artifactType: 'artifactType',

        // the properties below are optional
        mavenReference: {
          artifactId: 'artifactId',
          groupId: 'groupId',
          version: 'version',
        },
        s3ContentLocation: {
          bucketArn: 'bucketArn',
          fileKey: 'fileKey',

          // the properties below are optional
          objectVersion: 'objectVersion',
        },
      }],
      deployAsApplicationConfiguration: {
        s3ContentLocation: {
          bucketArn: 'bucketArn',

          // the properties below are optional
          basePath: 'basePath',
        },
      },
      monitoringConfiguration: {
        logLevel: 'logLevel',
      },
    },
  },
  applicationDescription: 'applicationDescription',
  applicationMaintenanceConfiguration: {
    applicationMaintenanceWindowStartTime: 'applicationMaintenanceWindowStartTime',
  },
  applicationMode: 'applicationMode',
  applicationName: 'applicationName',
  runConfiguration: {
    applicationRestoreConfiguration: {
      applicationRestoreType: 'applicationRestoreType',

      // the properties below are optional
      snapshotName: 'snapshotName',
    },
    flinkRunConfiguration: {
      allowNonRestoredState: false,
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
runtimeEnvironment	string	The runtime environment for the application.
serviceExecutionRole	string	Specifies the IAM role that the application uses to access external resources.
applicationConfiguration?	IResolvable | ApplicationConfigurationProperty	Use this parameter to configure the application.
applicationDescription?	string	The description of the application.
applicationMaintenanceConfiguration?	IResolvable | ApplicationMaintenanceConfigurationProperty	Specifies the maintenance window parameters for a Kinesis Data Analytics application.
applicationMode?	string	To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE .
applicationName?	string	The name of the application.
runConfiguration?	IResolvable | RunConfigurationProperty	Describes the starting parameters for an Managed Service for Apache Flink application.
tags?	CfnTag[]	A list of one or more tags to assign to the application.

---

runtimeEnvironment

Type: string

The runtime environment for the application.

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

---

serviceExecutionRole

Type: string

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

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

---

applicationConfiguration?

Type: IResolvable | ApplicationConfigurationProperty (optional)

Use this parameter to configure the application.

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

---

applicationDescription?

Type: string (optional, default: "")

The description of the application.

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

---

applicationMaintenanceConfiguration?

Type: IResolvable | ApplicationMaintenanceConfigurationProperty (optional)

Specifies the maintenance window parameters for a Kinesis Data Analytics application.

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

---

applicationMode?

Type: string (optional)

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.

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

---

applicationName?

Type: string (optional)

The name of the application.

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

---

runConfiguration?

Type: IResolvable | RunConfigurationProperty (optional)

Describes the starting parameters for an Managed Service for Apache Flink application.

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

---

tags?

Type: CfnTag[] (optional)

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.

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