pub struct DeleteFileSystemFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DeleteFileSystem
.
Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId
value to the DeleFileSystem
operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted.
To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a FileSystemId
value to the DeleFileSystem
operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem
operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup
to false
to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.
The DeleteFileSystem
operation returns while the file system has the DELETING
status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems
operation returns a FileSystemNotFound
error.
If a data repository task is in a PENDING
or EXECUTING
state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by any means.
Implementations§
source§impl DeleteFileSystemFluentBuilder
impl DeleteFileSystemFluentBuilder
sourcepub fn as_input(&self) -> &DeleteFileSystemInputBuilder
pub fn as_input(&self) -> &DeleteFileSystemInputBuilder
Access the DeleteFileSystem as a reference.
sourcepub async fn send(
self
) -> Result<DeleteFileSystemOutput, SdkError<DeleteFileSystemError, HttpResponse>>
pub async fn send( self ) -> Result<DeleteFileSystemOutput, SdkError<DeleteFileSystemError, 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<DeleteFileSystemOutput, DeleteFileSystemError, Self>
pub fn customize( self ) -> CustomizableOperation<DeleteFileSystemOutput, DeleteFileSystemError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn file_system_id(self, input: impl Into<String>) -> Self
pub fn file_system_id(self, input: impl Into<String>) -> Self
The ID of the file system that you want to delete.
sourcepub fn set_file_system_id(self, input: Option<String>) -> Self
pub fn set_file_system_id(self, input: Option<String>) -> Self
The ID of the file system that you want to delete.
sourcepub fn get_file_system_id(&self) -> &Option<String>
pub fn get_file_system_id(&self) -> &Option<String>
The ID of the file system that you want to delete.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.
sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.
sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.
sourcepub fn windows_configuration(
self,
input: DeleteFileSystemWindowsConfiguration
) -> Self
pub fn windows_configuration( self, input: DeleteFileSystemWindowsConfiguration ) -> Self
The configuration object for the Microsoft Windows file system used in the DeleteFileSystem
operation.
sourcepub fn set_windows_configuration(
self,
input: Option<DeleteFileSystemWindowsConfiguration>
) -> Self
pub fn set_windows_configuration( self, input: Option<DeleteFileSystemWindowsConfiguration> ) -> Self
The configuration object for the Microsoft Windows file system used in the DeleteFileSystem
operation.
sourcepub fn get_windows_configuration(
&self
) -> &Option<DeleteFileSystemWindowsConfiguration>
pub fn get_windows_configuration( &self ) -> &Option<DeleteFileSystemWindowsConfiguration>
The configuration object for the Microsoft Windows file system used in the DeleteFileSystem
operation.
sourcepub fn lustre_configuration(
self,
input: DeleteFileSystemLustreConfiguration
) -> Self
pub fn lustre_configuration( self, input: DeleteFileSystemLustreConfiguration ) -> Self
The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem
operation.
sourcepub fn set_lustre_configuration(
self,
input: Option<DeleteFileSystemLustreConfiguration>
) -> Self
pub fn set_lustre_configuration( self, input: Option<DeleteFileSystemLustreConfiguration> ) -> Self
The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem
operation.
sourcepub fn get_lustre_configuration(
&self
) -> &Option<DeleteFileSystemLustreConfiguration>
pub fn get_lustre_configuration( &self ) -> &Option<DeleteFileSystemLustreConfiguration>
The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem
operation.
sourcepub fn open_zfs_configuration(
self,
input: DeleteFileSystemOpenZfsConfiguration
) -> Self
pub fn open_zfs_configuration( self, input: DeleteFileSystemOpenZfsConfiguration ) -> Self
The configuration object for the OpenZFS file system used in the DeleteFileSystem
operation.
sourcepub fn set_open_zfs_configuration(
self,
input: Option<DeleteFileSystemOpenZfsConfiguration>
) -> Self
pub fn set_open_zfs_configuration( self, input: Option<DeleteFileSystemOpenZfsConfiguration> ) -> Self
The configuration object for the OpenZFS file system used in the DeleteFileSystem
operation.
sourcepub fn get_open_zfs_configuration(
&self
) -> &Option<DeleteFileSystemOpenZfsConfiguration>
pub fn get_open_zfs_configuration( &self ) -> &Option<DeleteFileSystemOpenZfsConfiguration>
The configuration object for the OpenZFS file system used in the DeleteFileSystem
operation.
Trait Implementations§
source§impl Clone for DeleteFileSystemFluentBuilder
impl Clone for DeleteFileSystemFluentBuilder
source§fn clone(&self) -> DeleteFileSystemFluentBuilder
fn clone(&self) -> DeleteFileSystemFluentBuilder
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 DeleteFileSystemFluentBuilder
impl !RefUnwindSafe for DeleteFileSystemFluentBuilder
impl Send for DeleteFileSystemFluentBuilder
impl Sync for DeleteFileSystemFluentBuilder
impl Unpin for DeleteFileSystemFluentBuilder
impl !UnwindSafe for DeleteFileSystemFluentBuilder
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