Class: Aws::KinesisAnalyticsV2::Types::UpdateApplicationRequest

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

Overview

Note:

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

{
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  application_configuration_update: {
    sql_application_configuration_update: {
      input_updates: [
        {
          input_id: "Id", # required
          name_prefix_update: "InAppStreamName",
          input_processing_configuration_update: {
            input_lambda_processor_update: { # required
              resource_arn_update: "ResourceARN", # required
            },
          },
          kinesis_streams_input_update: {
            resource_arn_update: "ResourceARN", # required
          },
          kinesis_firehose_input_update: {
            resource_arn_update: "ResourceARN", # required
          },
          input_schema_update: {
            record_format_update: {
              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_update: "RecordEncoding",
            record_column_updates: [
              {
                name: "RecordColumnName", # required
                mapping: "RecordColumnMapping",
                sql_type: "RecordColumnSqlType", # required
              },
            ],
          },
          input_parallelism_update: {
            count_update: 1, # required
          },
        },
      ],
      output_updates: [
        {
          output_id: "Id", # required
          name_update: "InAppStreamName",
          kinesis_streams_output_update: {
            resource_arn_update: "ResourceARN", # required
          },
          kinesis_firehose_output_update: {
            resource_arn_update: "ResourceARN", # required
          },
          lambda_output_update: {
            resource_arn_update: "ResourceARN", # required
          },
          destination_schema_update: {
            record_format_type: "JSON", # required, accepts JSON, CSV
          },
        },
      ],
      reference_data_source_updates: [
        {
          reference_id: "Id", # required
          table_name_update: "InAppTableName",
          s3_reference_data_source_update: {
            bucket_arn_update: "BucketARN",
            file_key_update: "FileKey",
          },
          reference_schema_update: {
            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
              },
            ],
          },
        },
      ],
    },
    application_code_configuration_update: {
      code_content_type_update: "PLAINTEXT", # accepts PLAINTEXT, ZIPFILE
      code_content_update: {
        text_content_update: "TextContent",
        zip_file_content_update: "data",
        s3_content_location_update: {
          bucket_arn_update: "BucketARN",
          file_key_update: "FileKey",
          object_version_update: "ObjectVersion",
        },
      },
    },
    flink_application_configuration_update: {
      checkpoint_configuration_update: {
        configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM
        checkpointing_enabled_update: false,
        checkpoint_interval_update: 1,
        min_pause_between_checkpoints_update: 1,
      },
      monitoring_configuration_update: {
        configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM
        metrics_level_update: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM
        log_level_update: "INFO", # accepts INFO, WARN, ERROR, DEBUG
      },
      parallelism_configuration_update: {
        configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM
        parallelism_update: 1,
        parallelism_per_kpu_update: 1,
        auto_scaling_enabled_update: false,
      },
    },
    environment_property_updates: {
      property_groups: [ # required
        {
          property_group_id: "Id", # required
          property_map: { # required
            "PropertyKey" => "PropertyValue",
          },
        },
      ],
    },
    application_snapshot_configuration_update: {
      snapshots_enabled_update: false, # required
    },
    vpc_configuration_updates: [
      {
        vpc_configuration_id: "Id", # required
        subnet_id_updates: ["SubnetId"],
        security_group_id_updates: ["SecurityGroupId"],
      },
    ],
  },
  service_execution_role_update: "RoleARN",
  run_configuration_update: {
    flink_run_configuration: {
      allow_non_restored_state: false,
    },
    application_restore_configuration: {
      application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT
      snapshot_name: "SnapshotName",
    },
  },
  cloud_watch_logging_option_updates: [
    {
      cloud_watch_logging_option_id: "Id", # required
      log_stream_arn_update: "LogStreamARN",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_configuration_updateTypes::ApplicationConfigurationUpdate

Describes application configuration updates.



5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 5916

class UpdateApplicationRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :application_configuration_update,
  :service_execution_role_update,
  :run_configuration_update,
  :cloud_watch_logging_option_updates)
  SENSITIVE = []
  include Aws::Structure
end

#application_nameString

The name of the application to update.

Returns:

  • (String)


5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 5916

class UpdateApplicationRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :application_configuration_update,
  :service_execution_role_update,
  :run_configuration_update,
  :cloud_watch_logging_option_updates)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_option_updatesArray<Types::CloudWatchLoggingOptionUpdate>

Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.



5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 5916

class UpdateApplicationRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :application_configuration_update,
  :service_execution_role_update,
  :run_configuration_update,
  :cloud_watch_logging_option_updates)
  SENSITIVE = []
  include Aws::Structure
end

#current_application_version_idInteger

The current application version ID. You can retrieve the application version ID using DescribeApplication.

Returns:

  • (Integer)


5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 5916

class UpdateApplicationRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :application_configuration_update,
  :service_execution_role_update,
  :run_configuration_update,
  :cloud_watch_logging_option_updates)
  SENSITIVE = []
  include Aws::Structure
end

#run_configuration_updateTypes::RunConfigurationUpdate

Describes updates to the application's starting parameters.



5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 5916

class UpdateApplicationRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :application_configuration_update,
  :service_execution_role_update,
  :run_configuration_update,
  :cloud_watch_logging_option_updates)
  SENSITIVE = []
  include Aws::Structure
end

#service_execution_role_updateString

Describes updates to the service execution role.

Returns:

  • (String)


5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 5916

class UpdateApplicationRequest < Struct.new(
  :application_name,
  :current_application_version_id,
  :application_configuration_update,
  :service_execution_role_update,
  :run_configuration_update,
  :cloud_watch_logging_option_updates)
  SENSITIVE = []
  include Aws::Structure
end