pub struct StopApplication { /* private fields */ }
Expand description
Fluent builder constructing a request to StopApplication
.
Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force
parameter to true
.
You can use the DescribeApplication
operation to find the application status.
Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force
is set to true
.
Implementations
sourceimpl StopApplication
impl StopApplication
sourcepub async fn send(
self
) -> Result<StopApplicationOutput, SdkError<StopApplicationError>>
pub async fn send(
self
) -> Result<StopApplicationOutput, SdkError<StopApplicationError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn application_name(self, input: impl Into<String>) -> Self
pub fn application_name(self, input: impl Into<String>) -> Self
The name of the running application to stop.
sourcepub fn set_application_name(self, input: Option<String>) -> Self
pub fn set_application_name(self, input: Option<String>) -> Self
The name of the running application to stop.
sourcepub fn force(self, input: bool) -> Self
pub fn force(self, input: bool) -> Self
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.
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.
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.
sourcepub fn set_force(self, input: Option<bool>) -> Self
pub fn set_force(self, input: Option<bool>) -> Self
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.
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.
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.
Trait Implementations
sourceimpl Clone for StopApplication
impl Clone for StopApplication
sourcefn clone(&self) -> StopApplication
fn clone(&self) -> StopApplication
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for StopApplication
impl Send for StopApplication
impl Sync for StopApplication
impl Unpin for StopApplication
impl !UnwindSafe for StopApplication
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more