Class: Aws::KinesisAnalyticsV2::Types::StopApplicationRequest

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 StopApplicationRequest data as a hash:

{
  application_name: "ApplicationName", # required
  force: false,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_name ⇒ String

The name of the running application to stop.

Returns:

  • (String) 


6466
6467
6468
6469
6470
6471
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 6466

class StopApplicationRequest < Struct.new(
  :application_name,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#force ⇒ Boolean

Set to `true` to force the application to stop. If you set `Force` to `true`, Kinesis Data Analytics stops the application without taking a snapshot.

<note markdown=“1”> Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.

</note>

You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.

The application must be in the `STARTING`, `UPDATING`, `STOPPING`, `AUTOSCALING`, or `RUNNING` status.

Returns:

  • (Boolean) 


6466
6467
6468
6469
6470
6471
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 6466

class StopApplicationRequest < Struct.new(
  :application_name,
  :force)
  SENSITIVE = []
  include Aws::Structure
end