pub struct StopInstanceFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StopInstance
.
Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The stop instance
operation supports tag-based access control via resource tags applied to the resource identified by instance name
. For more information, see the Amazon Lightsail Developer Guide.
Implementations§
source§impl StopInstanceFluentBuilder
impl StopInstanceFluentBuilder
sourcepub fn as_input(&self) -> &StopInstanceInputBuilder
pub fn as_input(&self) -> &StopInstanceInputBuilder
Access the StopInstance as a reference.
sourcepub async fn send(
self
) -> Result<StopInstanceOutput, SdkError<StopInstanceError, HttpResponse>>
pub async fn send( self ) -> Result<StopInstanceOutput, SdkError<StopInstanceError, HttpResponse>>
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 customize(
self
) -> CustomizableOperation<StopInstanceOutput, StopInstanceError, Self>
pub fn customize( self ) -> CustomizableOperation<StopInstanceOutput, StopInstanceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn instance_name(self, input: impl Into<String>) -> Self
pub fn instance_name(self, input: impl Into<String>) -> Self
The name of the instance (a virtual private server) to stop.
sourcepub fn set_instance_name(self, input: Option<String>) -> Self
pub fn set_instance_name(self, input: Option<String>) -> Self
The name of the instance (a virtual private server) to stop.
sourcepub fn get_instance_name(&self) -> &Option<String>
pub fn get_instance_name(&self) -> &Option<String>
The name of the instance (a virtual private server) to stop.
sourcepub fn force(self, input: bool) -> Self
pub fn force(self, input: bool) -> Self
When set to True
, forces a Lightsail instance that is stuck in a stopping
state to stop.
Only use the force
parameter if your instance is stuck in the stopping
state. In any other state, your instance should stop normally without adding this parameter to your API request.
sourcepub fn set_force(self, input: Option<bool>) -> Self
pub fn set_force(self, input: Option<bool>) -> Self
When set to True
, forces a Lightsail instance that is stuck in a stopping
state to stop.
Only use the force
parameter if your instance is stuck in the stopping
state. In any other state, your instance should stop normally without adding this parameter to your API request.
sourcepub fn get_force(&self) -> &Option<bool>
pub fn get_force(&self) -> &Option<bool>
When set to True
, forces a Lightsail instance that is stuck in a stopping
state to stop.
Only use the force
parameter if your instance is stuck in the stopping
state. In any other state, your instance should stop normally without adding this parameter to your API request.
Trait Implementations§
source§impl Clone for StopInstanceFluentBuilder
impl Clone for StopInstanceFluentBuilder
source§fn clone(&self) -> StopInstanceFluentBuilder
fn clone(&self) -> StopInstanceFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StopInstanceFluentBuilder
impl !RefUnwindSafe for StopInstanceFluentBuilder
impl Send for StopInstanceFluentBuilder
impl Sync for StopInstanceFluentBuilder
impl Unpin for StopInstanceFluentBuilder
impl !UnwindSafe for StopInstanceFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more