Class: Aws::KinesisAnalyticsV2::Types::CreateApplicationRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesisanalyticsv2/types.rb

Overview

Note:

When making an API call, you may pass CreateApplicationRequest data as a hash:

{
  application_name: "ApplicationName", # required
  application_description: "ApplicationDescription",
  runtime_environment: "SQL-1_0", # required, accepts SQL-1_0, FLINK-1_6, FLINK-1_8, ZEPPELIN-FLINK-1_0, FLINK-1_11, FLINK-1_13, ZEPPELIN-FLINK-2_0
  service_execution_role: "RoleARN", # required
  application_configuration: {
    sql_application_configuration: {
      inputs: [
        {
          name_prefix: "InAppStreamName", # required
          input_processing_configuration: {
            input_lambda_processor: { # required
              resource_arn: "ResourceARN", # required
            },
          },
          kinesis_streams_input: {
            resource_arn: "ResourceARN", # required
          },
          kinesis_firehose_input: {
            resource_arn: "ResourceARN", # required
          },
          input_parallelism: {
            count: 1,
          },
          input_schema: { # required
            record_format: { # required
              record_format_type: "JSON", # required, accepts JSON, CSV
              mapping_parameters: {
                json_mapping_parameters: {
                  record_row_path: "RecordRowPath", # required
                },
                csv_mapping_parameters: {
                  record_row_delimiter: "RecordRowDelimiter", # required
                  record_column_delimiter: "RecordColumnDelimiter", # required
                },
              },
            },
            record_encoding: "RecordEncoding",
            record_columns: [ # required
              {
                name: "RecordColumnName", # required
                mapping: "RecordColumnMapping",
                sql_type: "RecordColumnSqlType", # required
              },
            ],
          },
        },
      ],
      outputs: [
        {
          name: "InAppStreamName", # required
          kinesis_streams_output: {
            resource_arn: "ResourceARN", # required
          },
          kinesis_firehose_output: {
            resource_arn: "ResourceARN", # required
          },
          lambda_output: {
            resource_arn: "ResourceARN", # required
          },
          destination_schema: { # required
            record_format_type: "JSON", # required, accepts JSON, CSV
          },
        },
      ],
      reference_data_sources: [
        {
          table_name: "InAppTableName", # required
          s3_reference_data_source: {
            bucket_arn: "BucketARN",
            file_key: "FileKey",
          },
          reference_schema: { # required
            record_format: { # required
              record_format_type: "JSON", # required, accepts JSON, CSV
              mapping_parameters: {
                json_mapping_parameters: {
                  record_row_path: "RecordRowPath", # required
                },
                csv_mapping_parameters: {
                  record_row_delimiter: "RecordRowDelimiter", # required
                  record_column_delimiter: "RecordColumnDelimiter", # required
                },
              },
            },
            record_encoding: "RecordEncoding",
            record_columns: [ # required
              {
                name: "RecordColumnName", # required
                mapping: "RecordColumnMapping",
                sql_type: "RecordColumnSqlType", # required
              },
            ],
          },
        },
      ],
    },
    flink_application_configuration: {
      checkpoint_configuration: {
        configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
        checkpointing_enabled: false,
        checkpoint_interval: 1,
        min_pause_between_checkpoints: 1,
      },
      monitoring_configuration: {
        configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
        metrics_level: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM
        log_level: "INFO", # accepts INFO, WARN, ERROR, DEBUG
      },
      parallelism_configuration: {
        configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
        parallelism: 1,
        parallelism_per_kpu: 1,
        auto_scaling_enabled: false,
      },
    },
    environment_properties: {
      property_groups: [ # required
        {
          property_group_id: "Id", # required
          property_map: { # required
            "PropertyKey" => "PropertyValue",
          },
        },
      ],
    },
    application_code_configuration: {
      code_content: {
        text_content: "TextContent",
        zip_file_content: "data",
        s3_content_location: {
          bucket_arn: "BucketARN", # required
          file_key: "FileKey", # required
          object_version: "ObjectVersion",
        },
      },
      code_content_type: "PLAINTEXT", # required, accepts PLAINTEXT, ZIPFILE
    },
    application_snapshot_configuration: {
      snapshots_enabled: false, # required
    },
    vpc_configurations: [
      {
        subnet_ids: ["SubnetId"], # required
        security_group_ids: ["SecurityGroupId"], # required
      },
    ],
    zeppelin_application_configuration: {
      monitoring_configuration: {
        log_level: "INFO", # required, accepts INFO, WARN, ERROR, DEBUG
      },
      catalog_configuration: {
        glue_data_catalog_configuration: { # required
          database_arn: "DatabaseARN", # required
        },
      },
      deploy_as_application_configuration: {
        s3_content_location: { # required
          bucket_arn: "BucketARN", # required
          base_path: "BasePath",
        },
      },
      custom_artifacts_configuration: [
        {
          artifact_type: "UDF", # required, accepts UDF, DEPENDENCY_JAR
          s3_content_location: {
            bucket_arn: "BucketARN", # required
            file_key: "FileKey", # required
            object_version: "ObjectVersion",
          },
          maven_reference: {
            group_id: "MavenGroupId", # required
            artifact_id: "MavenArtifactId", # required
            version: "MavenVersion", # required
          },
        },
      ],
    },
  },
  cloud_watch_logging_options: [
    {
      log_stream_arn: "LogStreamARN", # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  application_mode: "STREAMING", # accepts STREAMING, INTERACTIVE
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_configuration ⇒ Types::ApplicationConfiguration

Use this parameter to configure the application.

Returns:



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end

#application_description ⇒ String

A summary description of the application.

Returns:

  • (String) 


2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end

#application_mode ⇒ String

Use the `STREAMING` mode to create a Kinesis Data Analytics Studio notebook. To create a Kinesis Data Analytics Studio notebook, use the `INTERACTIVE` mode.

Returns:

  • (String) 


2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end

#application_name ⇒ String

The name of your application (for example, `sample-app`).

Returns:

  • (String) 


2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_options ⇒ Array<Types::CloudWatchLoggingOption>

Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

Returns:



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_environment ⇒ String

The runtime environment for the application (`SQL-1_0`, `FLINK-1_6`, `FLINK-1_8`, or `FLINK-1_11`).

Returns:

  • (String) 


2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end

#service_execution_role ⇒ String

The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

Returns:

  • (String) 


2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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. For more information, see [Using Tagging].

[1]: docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html

Returns:



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2280

class CreateApplicationRequest < Struct.new(
  :application_name,
  :application_description,
  :runtime_environment,
  :service_execution_role,
  :application_configuration,
  :cloud_watch_logging_options,
  :tags,
  :application_mode)
  SENSITIVE = []
  include Aws::Structure
end