Struct aws_sdk_storagegateway::operation::shutdown_gateway::builders::ShutdownGatewayFluentBuilder

pub struct ShutdownGatewayFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ShutdownGateway.

Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.

The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

Implementations

impl ShutdownGatewayFluentBuilder

pub fn as_input(&self) -> &ShutdownGatewayInputBuilder

Access the ShutdownGateway as a reference.

pub async fn send( self ) -> Result<ShutdownGatewayOutput, SdkError<ShutdownGatewayError, 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.

pub fn customize( self ) -> CustomizableOperation<ShutdownGatewayOutput, ShutdownGatewayError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn gateway_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

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

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

pub fn get_gateway_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Trait Implementations

impl Clone for ShutdownGatewayFluentBuilder

fn clone(&self) -> ShutdownGatewayFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShutdownGatewayFluentBuilder

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

Formats the value using the given formatter.