Struct aws_sdk_lightsail::client::fluent_builders::StopInstance

pub struct StopInstance<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

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

impl<C, M, R> StopInstance<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StopInstanceOutput, SdkError<StopInstanceError>> where
    R::Policy: SmithyRetryPolicy<StopInstanceInputOperationOutputAlias, StopInstanceOutput, StopInstanceError, StopInstanceInputOperationRetryAlias>, 

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.

pub fn instance_name(self, inp: impl Into<String>) -> Self

The name of the instance (a virtual private server) to stop.

pub fn set_instance_name(self, input: Option<String>) -> Self

The name of the instance (a virtual private server) to stop.

pub fn force(self, inp: 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.

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for StopInstance<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.