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	awscc.kinesisanalyticsv2.applications

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
application_name	string	The name of the application.
region	string	AWS region.

For more information, see AWS::KinesisAnalyticsV2::Application.

Methods

Name	Resource	Accessible by	Required Params
create_resource	applications	INSERT	RuntimeEnvironment, ServiceExecutionRole, region
delete_resource	applications	DELETE	Identifier, region
update_resource	applications	UPDATE	Identifier, PatchDocument, region
list_resources	applications_list_only	SELECT	region
get_resource	applications	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.kinesisanalyticsv2.applications
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ application_name }}';

list (identifiers only)

Lists all applications in a region.

SELECT
  region,
  application_name
FROM awscc.kinesisanalyticsv2.applications_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.kinesisanalyticsv2.applications (
  ApplicationConfiguration,
  ApplicationDescription,
  ApplicationMode,
  ApplicationName,
  RuntimeEnvironment,
  ServiceExecutionRole,
  RunConfiguration,
  ApplicationMaintenanceConfiguration,
  Tags,
  region
)
SELECT
  '{{ application_configuration }}',
  '{{ application_description }}',
  '{{ application_mode }}',
  '{{ application_name }}',
  '{{ runtime_environment }}',
  '{{ service_execution_role }}',
  '{{ run_configuration }}',
  '{{ application_maintenance_configuration }}',
  '{{ 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: application_configuration
        value:
          application_code_configuration:
            code_content:
              zip_file_content: '{{ zip_file_content }}'
              s3_content_location:
                bucket_arn: '{{ bucket_arn }}'
                file_key: '{{ file_key }}'
                object_version: '{{ object_version }}'
              text_content: '{{ text_content }}'
            code_content_type: '{{ code_content_type }}'
          application_encryption_configuration:
            key_id: '{{ key_id }}'
            key_type: '{{ key_type }}'
          application_snapshot_configuration:
            snapshots_enabled: '{{ snapshots_enabled }}'
          application_system_rollback_configuration:
            rollback_enabled: '{{ rollback_enabled }}'
          environment_properties:
            property_groups:
              - property_group_id: '{{ property_group_id }}'
                property_map: {}
          flink_application_configuration:
            checkpoint_configuration:
              configuration_type: '{{ configuration_type }}'
              checkpointing_enabled: '{{ checkpointing_enabled }}'
              checkpoint_interval: '{{ checkpoint_interval }}'
              min_pause_between_checkpoints: '{{ min_pause_between_checkpoints }}'
            monitoring_configuration:
              configuration_type: '{{ configuration_type }}'
              metrics_level: '{{ metrics_level }}'
              log_level: '{{ log_level }}'
            parallelism_configuration:
              configuration_type: '{{ configuration_type }}'
              parallelism_per_kp_u: '{{ parallelism_per_kp_u }}'
              parallelism: '{{ parallelism }}'
              auto_scaling_enabled: '{{ auto_scaling_enabled }}'
          sql_application_configuration:
            inputs:
              - name_prefix: '{{ name_prefix }}'
                input_schema:
                  record_encoding: '{{ record_encoding }}'
                  record_columns:
                    - mapping: '{{ mapping }}'
                      name: '{{ name }}'
                      sql_type: '{{ sql_type }}'
                  record_format:
                    record_format_type: '{{ record_format_type }}'
                    mapping_parameters:
                      c_sv_mapping_parameters:
                        record_column_delimiter: '{{ record_column_delimiter }}'
                        record_row_delimiter: '{{ record_row_delimiter }}'
                      j_so_nmapping_parameters:
                        record_row_path: '{{ record_row_path }}'
                kinesis_streams_input:
                  resource_arn: null
                kinesis_firehose_input:
                  resource_arn: null
                input_processing_configuration:
                  input_lambda_processor:
                    resource_arn: null
                input_parallelism:
                  count: '{{ count }}'
          zeppelin_application_configuration:
            catalog_configuration:
              glue_data_catalog_configuration:
                database_arn: null
            monitoring_configuration:
              log_level: '{{ log_level }}'
            deploy_as_application_configuration:
              s3_content_location:
                bucket_arn: null
                base_path: '{{ base_path }}'
            custom_artifacts_configuration:
              - artifact_type: '{{ artifact_type }}'
                maven_reference:
                  artifact_id: '{{ artifact_id }}'
                  group_id: '{{ group_id }}'
                  version: '{{ version }}'
                s3_content_location: null
          vpc_configurations:
            - security_group_ids:
                - '{{ security_group_ids[0] }}'
              subnet_ids:
                - '{{ subnet_ids[0] }}'
      - name: application_description
        value: '{{ application_description }}'
      - name: application_mode
        value: '{{ application_mode }}'
      - name: application_name
        value: '{{ application_name }}'
      - name: runtime_environment
        value: '{{ runtime_environment }}'
      - name: service_execution_role
        value: null
      - name: run_configuration
        value:
          application_restore_configuration:
            application_restore_type: '{{ application_restore_type }}'
            snapshot_name: '{{ snapshot_name }}'
          flink_run_configuration:
            allow_non_restored_state: '{{ allow_non_restored_state }}'
      - name: application_maintenance_configuration
        value:
          application_maintenance_window_start_time: '{{ application_maintenance_window_start_time }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.kinesisanalyticsv2.applications
SET PatchDocument = string('{{ {
    "ApplicationConfiguration": application_configuration,
    "ApplicationDescription": application_description,
    "RuntimeEnvironment": runtime_environment,
    "ServiceExecutionRole": service_execution_role,
    "RunConfiguration": run_configuration,
    "ApplicationMaintenanceConfiguration": application_maintenance_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.kinesisanalyticsv2.applications
WHERE
  Identifier = '{{ application_name }}' 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,
kms:Decrypt,
kms:DescribeKey,
kms:GenerateDataKey,
kms:GenerateDataKeyWithoutPlaintext

Read

kinesisanalytics:DescribeApplication,
kinesisanalytics:ListTagsForResource,
kms:DescribeKey

Update

kinesisanalytics:UpdateApplication,
kinesisanalytics:DescribeApplication,
kinesisanalytics:TagResource,
kinesisanalytics:UntagResource,
kinesisanalytics:AddApplicationVpcConfiguration,
kinesisanalytics:DeleteApplicationVpcConfiguration,
kinesisanalytics:UpdateApplicationMaintenanceConfiguration,
kinesisanalytics:ListTagsForResource,
kms:CreateGrant,
kms:Decrypt,
kms:DescribeKey,
kms:GenerateDataKey,
kms:GenerateDataKeyWithoutPlaintext

Delete

kinesisanalytics:DescribeApplication,
kinesisanalytics:DeleteApplication

List

kinesisanalytics:ListApplications