applications

Creates, updates, deletes or gets an application resource or lists applications in a region

Overview

Name	applications
Type	Resource
Description	Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
Id	aws.kinesisanalyticsv2.applications

Fields

Name	Datatype	Description
application_configuration	object	Use this parameter to configure the application.
application_description	string	The description of the application.
application_mode	string	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	string	The name of the application.
runtime_environment	string	The runtime environment for the application.
service_execution_role	string	Specifies the IAM role that the application uses to access external resources.
run_configuration	object	Specifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only.
application_maintenance_configuration	object	Used to configure start of maintenance window.
tags	array	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.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RuntimeEnvironment, ServiceExecutionRole, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all applications in a region.

SELECT
region,
application_configuration,
application_description,
application_mode,
application_name,
runtime_environment,
service_execution_role,
run_configuration,
application_maintenance_configuration,
tags
FROM aws.kinesisanalyticsv2.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
application_configuration,
application_description,
application_mode,
application_name,
runtime_environment,
service_execution_role,
run_configuration,
application_maintenance_configuration,
tags
FROM aws.kinesisanalyticsv2.applications
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationName>';

INSERT example

Use the following StackQL query and manifest file to create a new application resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.kinesisanalyticsv2.applications (
 RuntimeEnvironment,
 ServiceExecutionRole,
 region
)
SELECT 
'{{ RuntimeEnvironment }}',
 '{{ ServiceExecutionRole }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.kinesisanalyticsv2.applications (
 ApplicationConfiguration,
 ApplicationDescription,
 ApplicationMode,
 ApplicationName,
 RuntimeEnvironment,
 ServiceExecutionRole,
 RunConfiguration,
 ApplicationMaintenanceConfiguration,
 Tags,
 region
)
SELECT 
 '{{ ApplicationConfiguration }}',
 '{{ ApplicationDescription }}',
 '{{ ApplicationMode }}',
 '{{ ApplicationName }}',
 '{{ RuntimeEnvironment }}',
 '{{ ServiceExecutionRole }}',
 '{{ RunConfiguration }}',
 '{{ ApplicationMaintenanceConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application
    props:
      - name: ApplicationConfiguration
        value:
          ApplicationCodeConfiguration:
            CodeContent:
              ZipFileContent: '{{ ZipFileContent }}'
              S3ContentLocation:
                BucketARN: '{{ BucketARN }}'
                FileKey: '{{ FileKey }}'
                ObjectVersion: '{{ ObjectVersion }}'
              TextContent: '{{ TextContent }}'
            CodeContentType: '{{ CodeContentType }}'
          ApplicationSnapshotConfiguration:
            SnapshotsEnabled: '{{ SnapshotsEnabled }}'
          EnvironmentProperties:
            PropertyGroups:
              - PropertyGroupId: '{{ PropertyGroupId }}'
                PropertyMap: {}
          FlinkApplicationConfiguration:
            CheckpointConfiguration:
              ConfigurationType: '{{ ConfigurationType }}'
              CheckpointingEnabled: '{{ CheckpointingEnabled }}'
              CheckpointInterval: '{{ CheckpointInterval }}'
              MinPauseBetweenCheckpoints: '{{ MinPauseBetweenCheckpoints }}'
            MonitoringConfiguration:
              ConfigurationType: '{{ ConfigurationType }}'
              MetricsLevel: '{{ MetricsLevel }}'
              LogLevel: '{{ LogLevel }}'
            ParallelismConfiguration:
              ConfigurationType: '{{ ConfigurationType }}'
              ParallelismPerKPU: '{{ ParallelismPerKPU }}'
              Parallelism: '{{ Parallelism }}'
              AutoScalingEnabled: '{{ AutoScalingEnabled }}'
          SqlApplicationConfiguration:
            Inputs:
              - NamePrefix: '{{ NamePrefix }}'
                InputSchema:
                  RecordEncoding: '{{ RecordEncoding }}'
                  RecordColumns:
                    - Mapping: '{{ Mapping }}'
                      Name: '{{ Name }}'
                      SqlType: '{{ SqlType }}'
                  RecordFormat:
                    RecordFormatType: '{{ RecordFormatType }}'
                    MappingParameters:
                      CSVMappingParameters:
                        RecordColumnDelimiter: '{{ RecordColumnDelimiter }}'
                        RecordRowDelimiter: '{{ RecordRowDelimiter }}'
                      JSONMappingParameters:
                        RecordRowPath: '{{ RecordRowPath }}'
                KinesisStreamsInput:
                  ResourceARN: null
                KinesisFirehoseInput:
                  ResourceARN: null
                InputProcessingConfiguration:
                  InputLambdaProcessor:
                    ResourceARN: null
                InputParallelism:
                  Count: '{{ Count }}'
          ZeppelinApplicationConfiguration:
            CatalogConfiguration:
              GlueDataCatalogConfiguration:
                DatabaseARN: null
            MonitoringConfiguration:
              LogLevel: '{{ LogLevel }}'
            DeployAsApplicationConfiguration:
              S3ContentLocation:
                BucketARN: null
                BasePath: '{{ BasePath }}'
            CustomArtifactsConfiguration:
              - ArtifactType: '{{ ArtifactType }}'
                MavenReference:
                  ArtifactId: '{{ ArtifactId }}'
                  GroupId: '{{ GroupId }}'
                  Version: '{{ Version }}'
                S3ContentLocation: null
          VpcConfigurations:
            - SecurityGroupIds:
                - '{{ SecurityGroupIds[0] }}'
              SubnetIds:
                - '{{ SubnetIds[0] }}'
      - name: ApplicationDescription
        value: '{{ ApplicationDescription }}'
      - name: ApplicationMode
        value: '{{ ApplicationMode }}'
      - name: ApplicationName
        value: '{{ ApplicationName }}'
      - name: RuntimeEnvironment
        value: '{{ RuntimeEnvironment }}'
      - name: ServiceExecutionRole
        value: null
      - name: RunConfiguration
        value:
          ApplicationRestoreConfiguration:
            ApplicationRestoreType: '{{ ApplicationRestoreType }}'
            SnapshotName: '{{ SnapshotName }}'
          FlinkRunConfiguration:
            AllowNonRestoredState: '{{ AllowNonRestoredState }}'
      - name: ApplicationMaintenanceConfiguration
        value:
          ApplicationMaintenanceWindowStartTime: '{{ ApplicationMaintenanceWindowStartTime }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.kinesisanalyticsv2.applications
WHERE data__Identifier = '<ApplicationName>'
AND region = 'us-east-1';

Permissions

To operate on the applications resource, the following permissions are required:

Create

iam:PassRole,
kinesisanalytics:CreateApplication,
kinesisanalytics:DescribeApplication,
kinesisanalytics:ListTagsForResource,
kinesisanalytics:UpdateApplicationMaintenanceConfiguration

Read

kinesisanalytics:DescribeApplication,
kinesisanalytics:ListTagsForResource

Update

kinesisanalytics:UpdateApplication,
kinesisanalytics:DescribeApplication,
kinesisanalytics:TagResource,
kinesisanalytics:UntagResource,
kinesisanalytics:AddApplicationVpcConfiguration,
kinesisanalytics:DeleteApplicationVpcConfiguration,
kinesisanalytics:UpdateApplicationMaintenanceConfiguration,
kinesisanalytics:ListTagsForResource

Delete

kinesisanalytics:DescribeApplication,
kinesisanalytics:DeleteApplication

List

kinesisanalytics:ListApplications