Struct aws_sdk_opsworkscm::operation::restore_server::builders::RestoreServerFluentBuilder

pub struct RestoreServerFluentBuilder { /* private fields */ }

Fluent builder constructing a request to RestoreServer.

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.

This operation is asynchronous.

An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Implementations

impl RestoreServerFluentBuilder

pub fn as_input(&self) -> &RestoreServerInputBuilder

Access the RestoreServer as a reference.

pub async fn send( self ) -> Result<RestoreServerOutput, SdkError<RestoreServerError, 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<RestoreServerOutput, RestoreServerError, Self>

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

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

The ID of the backup that you want to use to restore a server.

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

The ID of the backup that you want to use to restore a server.

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

The ID of the backup that you want to use to restore a server.

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

The name of the server that you want to restore.

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

The name of the server that you want to restore.

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

The name of the server that you want to restore.

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

The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

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

The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

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

The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

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

The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

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

The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

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

The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

Trait Implementations

impl Clone for RestoreServerFluentBuilder

fn clone(&self) -> RestoreServerFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RestoreServerFluentBuilder

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

Formats the value using the given formatter.