Struct aws_sdk_fsx::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon FSx
Client for invoking operations on Amazon FSx. Each operation on Amazon FSx is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_fsx::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_fsx::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateFileSystemAliases
operation has
a Client::associate_file_system_aliases
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_file_system_aliases()
.client_request_token("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_file_system_aliases(
&self
) -> AssociateFileSystemAliasesFluentBuilder
pub fn associate_file_system_aliases( &self ) -> AssociateFileSystemAliasesFluentBuilder
Constructs a fluent builder for the AssociateFileSystemAliases
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueSpecifies the file system with which you want to associate one or more DNS aliases.
aliases(impl Into<String>)
/set_aliases(Option<Vec::<String>>)
:
required: trueAn array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:
-
Formatted as a fully-qualified domain name (FQDN),
hostname.domain
, for example,accounting.corp.example.com
. -
Can contain alphanumeric characters and the hyphen (-).
-
Cannot start or end with a hyphen.
-
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
-
- On success, responds with
AssociateFileSystemAliasesOutput
with field(s):aliases(Option<Vec::<Alias>>)
:An array of the DNS aliases that Amazon FSx is associating with the file system.
- On failure, responds with
SdkError<AssociateFileSystemAliasesError>
source§impl Client
impl Client
sourcepub fn cancel_data_repository_task(
&self
) -> CancelDataRepositoryTaskFluentBuilder
pub fn cancel_data_repository_task( &self ) -> CancelDataRepositoryTaskFluentBuilder
Constructs a fluent builder for the CancelDataRepositoryTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
:
required: trueSpecifies the data repository task to cancel.
- On success, responds with
CancelDataRepositoryTaskOutput
with field(s):lifecycle(Option<DataRepositoryTaskLifecycle>)
:The lifecycle status of the data repository task, as follows:
-
PENDING
- Amazon FSx has not started the task. -
EXECUTING
- Amazon FSx is processing the task. -
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. TheDataRepositoryTaskFailureDetails
property provides more information about task failures. -
SUCCEEDED
- FSx completed the task successfully. -
CANCELED
- Amazon FSx canceled the task and it did not complete. -
CANCELING
- FSx is in process of canceling the task.
-
task_id(Option<String>)
:The ID of the task being canceled.
- On failure, responds with
SdkError<CancelDataRepositoryTaskError>
source§impl Client
impl Client
sourcepub fn copy_backup(&self) -> CopyBackupFluentBuilder
pub fn copy_backup(&self) -> CopyBackupFluentBuilder
Constructs a fluent builder for the CopyBackup
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
source_backup_id(impl Into<String>)
/set_source_backup_id(Option<String>)
:
required: trueThe ID of the source backup. Specifies the ID of the backup that’s being copied.
source_region(impl Into<String>)
/set_source_region(Option<String>)
:
required: falseThe source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don’t specify a Region,
SourceRegion
defaults to the Region where the request is sent from (in-Region copy).kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseSpecifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a
KmsKeyId
isn’t specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.-
copy_tags(bool)
/set_copy_tags(Option<bool>)
:
required: falseA Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to
false
.If you set
CopyTags
totrue
and the source backup has existing tags, you can use theTags
parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn’t exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with theTags
parameter take precedence.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.
- On success, responds with
CopyBackupOutput
with field(s):backup(Option<Backup>)
:A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.
- On failure, responds with
SdkError<CopyBackupError>
source§impl Client
impl Client
sourcepub fn copy_snapshot_and_update_volume(
&self
) -> CopySnapshotAndUpdateVolumeFluentBuilder
pub fn copy_snapshot_and_update_volume( &self ) -> CopySnapshotAndUpdateVolumeFluentBuilder
Constructs a fluent builder for the CopySnapshotAndUpdateVolume
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
volume_id(impl Into<String>)
/set_volume_id(Option<String>)
:
required: trueSpecifies the ID of the volume that you are copying the snapshot to.
source_snapshot_arn(impl Into<String>)
/set_source_snapshot_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
copy_strategy(OpenZfsCopyStrategy)
/set_copy_strategy(Option<OpenZfsCopyStrategy>)
:
required: falseSpecifies the strategy to use when copying data from a snapshot to the volume.
-
FULL_COPY
- Copies all data from the snapshot to the volume. -
INCREMENTAL_COPY
- Copies only the snapshot data that’s changed since the previous replication.
CLONE
isn’t a valid copy strategy option for theCopySnapshotAndUpdateVolume
operation.-
options(UpdateOpenZfsVolumeOption)
/set_options(Option<Vec::<UpdateOpenZfsVolumeOption>>)
:
required: falseConfirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.
Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include
DELETE_INTERMEDIATE_SNAPSHOTS
and there are intermediate snapshots on the destination, you can’t copy the snapshot.-
DELETE_INTERMEDIATE_SNAPSHOTS
- Deletes snapshots on the destination volume that aren’t on the source volume. -
DELETE_CLONED_VOLUMES
- Deletes snapshot clones on the destination volume that aren’t on the source volume. -
DELETE_INTERMEDIATE_DATA
- Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.
-
- On success, responds with
CopySnapshotAndUpdateVolumeOutput
with field(s):volume_id(Option<String>)
:The ID of the volume that you copied the snapshot to.
lifecycle(Option<VolumeLifecycle>)
:The lifecycle state of the destination volume.
administrative_actions(Option<Vec::<AdministrativeAction>>)
:A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
- On failure, responds with
SdkError<CopySnapshotAndUpdateVolumeError>
source§impl Client
impl Client
sourcepub fn create_backup(&self) -> CreateBackupFluentBuilder
pub fn create_backup(&self) -> CreateBackupFluentBuilder
Constructs a fluent builder for the CreateBackup
operation.
- The fluent builder is configurable:
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: falseThe ID of the file system to back up.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: false(Optional) The tags to apply to the backup at backup creation. The key value of the
Name
tag appears in the console as the backup name. If you have setCopyTagsToBackups
totrue
, and you specify one or more tags using theCreateBackup
operation, no existing file system tags are copied from the file system to the backup.volume_id(impl Into<String>)
/set_volume_id(Option<String>)
:
required: false(Optional) The ID of the FSx for ONTAP volume to back up.
- On success, responds with
CreateBackupOutput
with field(s):backup(Option<Backup>)
:A description of the backup.
- On failure, responds with
SdkError<CreateBackupError>
source§impl Client
impl Client
sourcepub fn create_data_repository_association(
&self
) -> CreateDataRepositoryAssociationFluentBuilder
pub fn create_data_repository_association( &self ) -> CreateDataRepositoryAssociationFluentBuilder
Constructs a fluent builder for the CreateDataRepositoryAssociation
operation.
- The fluent builder is configurable:
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe globally unique ID of the file system, assigned by Amazon FSx.
file_system_path(impl Into<String>)
/set_file_system_path(Option<String>)
:
required: falseA path on the file system that points to a high-level directory (such as
/ns1/
) or subdirectory (such as/ns1/subdir/
) that will be mapped 1-1 withDataRepositoryPath
. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path/ns1/
, then you cannot link another data repository with file system path/ns1/ns2
.This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (
/
) as the file system path, you can link only one data repository to the file system. You can only specify “/” as the file system path for the first data repository associated with a file system.data_repository_path(impl Into<String>)
/set_data_repository_path(Option<String>)
:
required: trueThe path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix/
. This path specifies where in the S3 data repository files will be imported from or exported to.batch_import_meta_data_on_create(bool)
/set_batch_import_meta_data_on_create(Option<bool>)
:
required: falseSet to
true
to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default isfalse
.imported_file_chunk_size(i32)
/set_imported_file_chunk_size(Option<i32>)
:
required: falseFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
s3(S3DataRepositoryConfiguration)
/set_s3(Option<S3DataRepositoryConfiguration>)
:
required: falseThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.
- On success, responds with
CreateDataRepositoryAssociationOutput
with field(s):association(Option<DataRepositoryAssociation>)
:The response object returned after the data repository association is created.
- On failure, responds with
SdkError<CreateDataRepositoryAssociationError>
source§impl Client
impl Client
sourcepub fn create_data_repository_task(
&self
) -> CreateDataRepositoryTaskFluentBuilder
pub fn create_data_repository_task( &self ) -> CreateDataRepositoryTaskFluentBuilder
Constructs a fluent builder for the CreateDataRepositoryTask
operation.
- The fluent builder is configurable:
r#type(DataRepositoryTaskType)
/set_type(Option<DataRepositoryTaskType>)
:
required: trueSpecifies the type of data repository task to create.
-
EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data repository. -
IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system. -
RELEASE_DATA_FROM_FILESYSTEM
tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria. -
AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
-
paths(impl Into<String>)
/set_paths(Option<Vec::<String>>)
:
required: falseA list of paths for the data repository task to use when the task is processed. If a path that you provide isn’t valid, the task fails. If you don’t provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).
-
For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is
/mnt/fsx
and/mnt/fsx/path1
is a directory or file on the file system you want to export, then the path to provide ispath1
. -
For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix
(wheremyPrefix
is optional). -
For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.
A file must also meet the last accessed time criteria specified in for the file to be released.
-
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe globally unique ID of the file system, assigned by Amazon FSx.
report(CompletionReport)
/set_report(Option<CompletionReport>)
:
required: trueDefines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the
Scope
parameter. For more information, see Working with Task Completion Reports.client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.capacity_to_release(i64)
/set_capacity_to_release(Option<i64>)
:
required: falseSpecifies the amount of data to release, in GiB, by an Amazon File Cache
AUTO_RELEASE_DATA
task that automatically releases files from the cache.release_configuration(ReleaseConfiguration)
/set_release_configuration(Option<ReleaseConfiguration>)
:
required: falseThe configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.
- On success, responds with
CreateDataRepositoryTaskOutput
with field(s):data_repository_task(Option<DataRepositoryTask>)
:The description of the data repository task that you just created.
- On failure, responds with
SdkError<CreateDataRepositoryTaskError>
source§impl Client
impl Client
sourcepub fn create_file_cache(&self) -> CreateFileCacheFluentBuilder
pub fn create_file_cache(&self) -> CreateFileCacheFluentBuilder
Constructs a fluent builder for the CreateFileCache
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseAn idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a
CreateFileCache
operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.file_cache_type(FileCacheType)
/set_file_cache_type(Option<FileCacheType>)
:
required: trueThe type of cache that you’re creating, which must be
LUSTRE
.file_cache_type_version(impl Into<String>)
/set_file_cache_type_version(Option<String>)
:
required: trueSets the Lustre version for the cache that you’re creating, which must be
2.12
.storage_capacity(i32)
/set_storage_capacity(Option<i32>)
:
required: trueThe storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueA list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the
CreateFileCache
operation.security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseA list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn’t returned in later requests to describe the cache.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.copy_tags_to_data_repository_associations(bool)
/set_copy_tags_to_data_repository_associations(Option<bool>)
:
required: falseA boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseSpecifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyId
isn’t specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.lustre_configuration(CreateFileCacheLustreConfiguration)
/set_lustre_configuration(Option<CreateFileCacheLustreConfiguration>)
:
required: falseThe configuration for the Amazon File Cache resource being created.
data_repository_associations(FileCacheDataRepositoryAssociation)
/set_data_repository_associations(Option<Vec::<FileCacheDataRepositoryAssociation>>)
:
required: falseA list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can’t link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
-
- On success, responds with
CreateFileCacheOutput
with field(s):file_cache(Option<FileCacheCreating>)
:A description of the cache that was created.
- On failure, responds with
SdkError<CreateFileCacheError>
source§impl Client
impl Client
sourcepub fn create_file_system(&self) -> CreateFileSystemFluentBuilder
pub fn create_file_system(&self) -> CreateFileSystemFluentBuilder
Constructs a fluent builder for the CreateFileSystem
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
file_system_type(FileSystemType)
/set_file_system_type(Option<FileSystemType>)
:
required: trueThe type of Amazon FSx file system to create. Valid values are
WINDOWS
,LUSTRE
,ONTAP
, andOPENZFS
.storage_capacity(i32)
/set_storage_capacity(Option<i32>)
:
required: trueSets the storage capacity of the file system that you’re creating, in gibibytes (GiB).
FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for
StorageType
and the LustreDeploymentType
, as follows:-
For
SCRATCH_2
,PERSISTENT_2
andPERSISTENT_1
deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. -
For
PERSISTENT_1
HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. -
For
SCRATCH_1
deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the
HAPairs
property. The minimum value is calculated as 1,024 *HAPairs
and the maximum is calculated as 524,288 *HAPairs
.FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for
StorageType
as follows:-
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
-
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
-
storage_type(StorageType)
/set_storage_type(Option<StorageType>)
:
required: falseSets the storage type for the file system that you’re creating. Valid values are
SSD
andHDD
.-
Set to
SSD
to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. -
Set to
HDD
to use hard disk drive storage. HDD is supported onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_1
Lustre file system deployment types.
Default value is
SSD
. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.-
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueSpecifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP
MULTI_AZ_1
deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using theWindowsConfiguration > PreferredSubnetID
orOntapConfiguration > PreferredSubnetID
properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.For Windows
SINGLE_AZ_1
andSINGLE_AZ_2
and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet’s Availability Zone.security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseA list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn’t returned in later requests to describe the file system.
You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe tags to apply to the file system that’s being created. The key value of the
Name
tag appears in the console as the file system name.kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseSpecifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a
KmsKeyId
isn’t specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.-
windows_configuration(CreateFileSystemWindowsConfiguration)
/set_windows_configuration(Option<CreateFileSystemWindowsConfiguration>)
:
required: falseThe Microsoft Windows configuration for the file system that’s being created.
lustre_configuration(CreateFileSystemLustreConfiguration)
/set_lustre_configuration(Option<CreateFileSystemLustreConfiguration>)
:
required: falseThe Lustre configuration for the file system being created.
The following parameters are not supported for file systems with a data repository association created with .
-
AutoImportPolicy
-
ExportPath
-
ImportedFileChunkSize
-
ImportPath
-
ontap_configuration(CreateFileSystemOntapConfiguration)
/set_ontap_configuration(Option<CreateFileSystemOntapConfiguration>)
:
required: falseThe ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
file_system_type_version(impl Into<String>)
/set_file_system_type_version(Option<String>)
:
required: false(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you’re creating. Valid values are
2.10
,2.12
, and2.15
:-
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
-
2.12 and 2.15 are supported by all Lustre deployment types.
2.12
or2.15
is required when setting FSx for LustreDeploymentType
toPERSISTENT_2
.
Default value =
2.10
, except whenDeploymentType
is set toPERSISTENT_2
, then the default is2.12
.If you set
FileSystemTypeVersion
to2.10
for aPERSISTENT_2
Lustre deployment type, theCreateFileSystem
operation fails.-
open_zfs_configuration(CreateFileSystemOpenZfsConfiguration)
/set_open_zfs_configuration(Option<CreateFileSystemOpenZfsConfiguration>)
:
required: falseThe OpenZFS configuration for the file system that’s being created.
- On success, responds with
CreateFileSystemOutput
with field(s):file_system(Option<FileSystem>)
:The configuration of the file system that was created.
- On failure, responds with
SdkError<CreateFileSystemError>
source§impl Client
impl Client
sourcepub fn create_file_system_from_backup(
&self
) -> CreateFileSystemFromBackupFluentBuilder
pub fn create_file_system_from_backup( &self ) -> CreateFileSystemFromBackupFluentBuilder
Constructs a fluent builder for the CreateFileSystemFromBackup
operation.
- The fluent builder is configurable:
backup_id(impl Into<String>)
/set_backup_id(Option<String>)
:
required: trueThe ID of the source backup. Specifies the backup that you are copying.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueSpecifies the IDs of the subnets that the file system will be accessible from. For Windows
MULTI_AZ_1
file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using theWindowsConfiguration > PreferredSubnetID
property.Windows
SINGLE_AZ_1
andSINGLE_AZ_2
file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet’s Availability Zone.security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseA list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn’t returned in later
DescribeFileSystem
requests.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe tags to be applied to the file system at file system creation. The key value of the
Name
tag appears in the console as the file system name.windows_configuration(CreateFileSystemWindowsConfiguration)
/set_windows_configuration(Option<CreateFileSystemWindowsConfiguration>)
:
required: falseThe configuration for this Microsoft Windows file system.
lustre_configuration(CreateFileSystemLustreConfiguration)
/set_lustre_configuration(Option<CreateFileSystemLustreConfiguration>)
:
required: falseThe Lustre configuration for the file system being created.
The following parameters are not supported for file systems with a data repository association created with .
-
AutoImportPolicy
-
ExportPath
-
ImportedFileChunkSize
-
ImportPath
-
storage_type(StorageType)
/set_storage_type(Option<StorageType>)
:
required: falseSets the storage type for the Windows or OpenZFS file system that you’re creating from a backup. Valid values are
SSD
andHDD
.-
Set to
SSD
to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types. -
Set to
HDD
to use hard disk drive storage. HDD is supported onSINGLE_AZ_2
andMULTI_AZ_1
FSx for Windows File Server file system deployment types.
The default value is
SSD
.HDD and SSD storage types have different minimum storage capacity requirements. A restored file system’s storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.
-
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseSpecifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a
KmsKeyId
isn’t specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.-
file_system_type_version(impl Into<String>)
/set_file_system_type_version(Option<String>)
:
required: falseSets the version for the Amazon FSx for Lustre file system that you’re creating from a backup. Valid values are
2.10
,2.12
, and2.15
.You don’t need to specify
FileSystemTypeVersion
because it will be applied using the backup’sFileSystemTypeVersion
setting. If you choose to specifyFileSystemTypeVersion
when creating from backup, the value must match the backup’sFileSystemTypeVersion
setting.open_zfs_configuration(CreateFileSystemOpenZfsConfiguration)
/set_open_zfs_configuration(Option<CreateFileSystemOpenZfsConfiguration>)
:
required: falseThe OpenZFS configuration for the file system that’s being created.
storage_capacity(i32)
/set_storage_capacity(Option<i32>)
:
required: falseSets the storage capacity of the OpenZFS file system that you’re creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup’s storage capacity value. If you don’t use the
StorageCapacity
parameter, the default is the backup’sStorageCapacity
value.If used to create a file system other than OpenZFS, you must provide a value that matches the backup’s
StorageCapacity
value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.
- On success, responds with
CreateFileSystemFromBackupOutput
with field(s):file_system(Option<FileSystem>)
:A description of the file system.
- On failure, responds with
SdkError<CreateFileSystemFromBackupError>
source§impl Client
impl Client
sourcepub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder
pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder
Constructs a fluent builder for the CreateSnapshot
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the snapshot.
volume_id(impl Into<String>)
/set_volume_id(Option<String>)
:
required: trueThe ID of the volume that you are taking a snapshot of.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.
- On success, responds with
CreateSnapshotOutput
with field(s):snapshot(Option<Snapshot>)
:A description of the snapshot.
- On failure, responds with
SdkError<CreateSnapshotError>
source§impl Client
impl Client
sourcepub fn create_storage_virtual_machine(
&self
) -> CreateStorageVirtualMachineFluentBuilder
pub fn create_storage_virtual_machine( &self ) -> CreateStorageVirtualMachineFluentBuilder
Constructs a fluent builder for the CreateStorageVirtualMachine
operation.
- The fluent builder is configurable:
active_directory_configuration(CreateSvmActiveDirectoryConfiguration)
/set_active_directory_configuration(Option<CreateSvmActiveDirectoryConfiguration>)
:
required: falseDescribes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe globally unique ID of the file system, assigned by Amazon FSx.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the SVM.
svm_admin_password(impl Into<String>)
/set_svm_admin_password(Option<String>)
:
required: falseThe password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system’s
fsxadmin
user to manage the SVM.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.root_volume_security_style(StorageVirtualMachineRootVolumeSecurityStyle)
/set_root_volume_security_style(Option<StorageVirtualMachineRootVolumeSecurityStyle>)
:
required: falseThe security style of the root volume of the SVM. Specify one of the following values:
-
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. -
NTFS
if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account. -
MIXED
This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
-
- On success, responds with
CreateStorageVirtualMachineOutput
with field(s):storage_virtual_machine(Option<StorageVirtualMachine>)
:Returned after a successful
CreateStorageVirtualMachine
operation; describes the SVM just created.
- On failure, responds with
SdkError<CreateStorageVirtualMachineError>
source§impl Client
impl Client
sourcepub fn create_volume(&self) -> CreateVolumeFluentBuilder
pub fn create_volume(&self) -> CreateVolumeFluentBuilder
Constructs a fluent builder for the CreateVolume
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
volume_type(VolumeType)
/set_volume_type(Option<VolumeType>)
:
required: trueSpecifies the type of volume to create;
ONTAP
andOPENZFS
are the only valid volume types.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueSpecifies the name of the volume that you’re creating.
ontap_configuration(CreateOntapVolumeConfiguration)
/set_ontap_configuration(Option<CreateOntapVolumeConfiguration>)
:
required: falseSpecifies the configuration to use when creating the ONTAP volume.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.open_zfs_configuration(CreateOpenZfsVolumeConfiguration)
/set_open_zfs_configuration(Option<CreateOpenZfsVolumeConfiguration>)
:
required: falseSpecifies the configuration to use when creating the OpenZFS volume.
- On success, responds with
CreateVolumeOutput
with field(s):volume(Option<Volume>)
:Returned after a successful
CreateVolume
API operation, describing the volume just created.
- On failure, responds with
SdkError<CreateVolumeError>
source§impl Client
impl Client
sourcepub fn create_volume_from_backup(&self) -> CreateVolumeFromBackupFluentBuilder
pub fn create_volume_from_backup(&self) -> CreateVolumeFromBackupFluentBuilder
Constructs a fluent builder for the CreateVolumeFromBackup
operation.
- The fluent builder is configurable:
backup_id(impl Into<String>)
/set_backup_id(Option<String>)
:
required: trueThe ID of the source backup. Specifies the backup that you are copying.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the new volume you’re creating.
ontap_configuration(CreateOntapVolumeConfiguration)
/set_ontap_configuration(Option<CreateOntapVolumeConfiguration>)
:
required: falseSpecifies the configuration of the ONTAP volume that you are creating.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of
Tag
values, with a maximum of 50 elements.
- On success, responds with
CreateVolumeFromBackupOutput
with field(s):volume(Option<Volume>)
:Returned after a successful
CreateVolumeFromBackup
API operation, describing the volume just created.
- On failure, responds with
SdkError<CreateVolumeFromBackupError>
source§impl Client
impl Client
sourcepub fn delete_backup(&self) -> DeleteBackupFluentBuilder
pub fn delete_backup(&self) -> DeleteBackupFluentBuilder
Constructs a fluent builder for the DeleteBackup
operation.
- The fluent builder is configurable:
backup_id(impl Into<String>)
/set_backup_id(Option<String>)
:
required: trueThe ID of the backup that you want to delete.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK.
- On success, responds with
DeleteBackupOutput
with field(s):backup_id(Option<String>)
:The ID of the backup that was deleted.
lifecycle(Option<BackupLifecycle>)
:The lifecycle status of the backup. If the
DeleteBackup
operation is successful, the status isDELETED
.
- On failure, responds with
SdkError<DeleteBackupError>
source§impl Client
impl Client
sourcepub fn delete_data_repository_association(
&self
) -> DeleteDataRepositoryAssociationFluentBuilder
pub fn delete_data_repository_association( &self ) -> DeleteDataRepositoryAssociationFluentBuilder
Constructs a fluent builder for the DeleteDataRepositoryAssociation
operation.
- The fluent builder is configurable:
association_id(impl Into<String>)
/set_association_id(Option<String>)
:
required: trueThe ID of the data repository association that you want to delete.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
delete_data_in_file_system(bool)
/set_delete_data_in_file_system(Option<bool>)
:
required: falseSet to
true
to delete the data in the file system that corresponds to the data repository association.
- On success, responds with
DeleteDataRepositoryAssociationOutput
with field(s):association_id(Option<String>)
:The ID of the data repository association being deleted.
lifecycle(Option<DataRepositoryLifecycle>)
:Describes the lifecycle state of the data repository association being deleted.
delete_data_in_file_system(Option<bool>)
:Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is
false
.
- On failure, responds with
SdkError<DeleteDataRepositoryAssociationError>
source§impl Client
impl Client
sourcepub fn delete_file_cache(&self) -> DeleteFileCacheFluentBuilder
pub fn delete_file_cache(&self) -> DeleteFileCacheFluentBuilder
Constructs a fluent builder for the DeleteFileCache
operation.
- The fluent builder is configurable:
file_cache_id(impl Into<String>)
/set_file_cache_id(Option<String>)
:
required: trueThe ID of the cache that’s being deleted.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
- On success, responds with
DeleteFileCacheOutput
with field(s):file_cache_id(Option<String>)
:The ID of the cache that’s being deleted.
lifecycle(Option<FileCacheLifecycle>)
:The cache lifecycle for the deletion request. If the
DeleteFileCache
operation is successful, this status isDELETING
.
- On failure, responds with
SdkError<DeleteFileCacheError>
source§impl Client
impl Client
sourcepub fn delete_file_system(&self) -> DeleteFileSystemFluentBuilder
pub fn delete_file_system(&self) -> DeleteFileSystemFluentBuilder
Constructs a fluent builder for the DeleteFileSystem
operation.
- The fluent builder is configurable:
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe ID of the file system that you want to delete.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA 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.
windows_configuration(DeleteFileSystemWindowsConfiguration)
/set_windows_configuration(Option<DeleteFileSystemWindowsConfiguration>)
:
required: falseThe configuration object for the Microsoft Windows file system used in the
DeleteFileSystem
operation.lustre_configuration(DeleteFileSystemLustreConfiguration)
/set_lustre_configuration(Option<DeleteFileSystemLustreConfiguration>)
:
required: falseThe configuration object for the Amazon FSx for Lustre file system being deleted in the
DeleteFileSystem
operation.open_zfs_configuration(DeleteFileSystemOpenZfsConfiguration)
/set_open_zfs_configuration(Option<DeleteFileSystemOpenZfsConfiguration>)
:
required: falseThe configuration object for the OpenZFS file system used in the
DeleteFileSystem
operation.
- On success, responds with
DeleteFileSystemOutput
with field(s):file_system_id(Option<String>)
:The ID of the file system that’s being deleted.
lifecycle(Option<FileSystemLifecycle>)
:The file system lifecycle for the deletion request. If the
DeleteFileSystem
operation is successful, this status isDELETING
.windows_response(Option<DeleteFileSystemWindowsResponse>)
:The response object for the Microsoft Windows file system used in the
DeleteFileSystem
operation.lustre_response(Option<DeleteFileSystemLustreResponse>)
:The response object for the Amazon FSx for Lustre file system being deleted in the
DeleteFileSystem
operation.open_zfs_response(Option<DeleteFileSystemOpenZfsResponse>)
:The response object for the OpenZFS file system that’s being deleted in the
DeleteFileSystem
operation.
- On failure, responds with
SdkError<DeleteFileSystemError>
source§impl Client
impl Client
sourcepub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder
pub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder
Constructs a fluent builder for the DeleteSnapshot
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
snapshot_id(impl Into<String>)
/set_snapshot_id(Option<String>)
:
required: trueThe ID of the snapshot that you want to delete.
- On success, responds with
DeleteSnapshotOutput
with field(s):snapshot_id(Option<String>)
:The ID of the deleted snapshot.
lifecycle(Option<SnapshotLifecycle>)
:The lifecycle status of the snapshot. If the
DeleteSnapshot
operation is successful, this status isDELETING
.
- On failure, responds with
SdkError<DeleteSnapshotError>
source§impl Client
impl Client
sourcepub fn delete_storage_virtual_machine(
&self
) -> DeleteStorageVirtualMachineFluentBuilder
pub fn delete_storage_virtual_machine( &self ) -> DeleteStorageVirtualMachineFluentBuilder
Constructs a fluent builder for the DeleteStorageVirtualMachine
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
storage_virtual_machine_id(impl Into<String>)
/set_storage_virtual_machine_id(Option<String>)
:
required: trueThe ID of the SVM that you want to delete.
- On success, responds with
DeleteStorageVirtualMachineOutput
with field(s):storage_virtual_machine_id(Option<String>)
:The ID of the SVM Amazon FSx is deleting.
lifecycle(Option<StorageVirtualMachineLifecycle>)
:Describes the lifecycle state of the SVM being deleted.
- On failure, responds with
SdkError<DeleteStorageVirtualMachineError>
source§impl Client
impl Client
sourcepub fn delete_volume(&self) -> DeleteVolumeFluentBuilder
pub fn delete_volume(&self) -> DeleteVolumeFluentBuilder
Constructs a fluent builder for the DeleteVolume
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
volume_id(impl Into<String>)
/set_volume_id(Option<String>)
:
required: trueThe ID of the volume that you are deleting.
ontap_configuration(DeleteVolumeOntapConfiguration)
/set_ontap_configuration(Option<DeleteVolumeOntapConfiguration>)
:
required: falseFor Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the
fsx:TagResource
permission.open_zfs_configuration(DeleteVolumeOpenZfsConfiguration)
/set_open_zfs_configuration(Option<DeleteVolumeOpenZfsConfiguration>)
:
required: falseFor Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.
- On success, responds with
DeleteVolumeOutput
with field(s):volume_id(Option<String>)
:The ID of the volume that’s being deleted.
lifecycle(Option<VolumeLifecycle>)
:The lifecycle state of the volume being deleted. If the
DeleteVolume
operation is successful, this value isDELETING
.ontap_response(Option<DeleteVolumeOntapResponse>)
:Returned after a
DeleteVolume
request, showing the status of the delete request.
- On failure, responds with
SdkError<DeleteVolumeError>
source§impl Client
impl Client
sourcepub fn describe_backups(&self) -> DescribeBackupsFluentBuilder
pub fn describe_backups(&self) -> DescribeBackupsFluentBuilder
Constructs a fluent builder for the DescribeBackups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
backup_ids(impl Into<String>)
/set_backup_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren’t found, a
BackupNotFound
error occurs.filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseThe filters structure. The supported names are
file-system-id
,backup-type
,file-system-type
, andvolume-id
.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the
MaxResults
parameter specified in the request and the service’s internal maximum number of items per page.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn opaque pagination token returned from a previous
DescribeBackups
operation. If a token is present, the operation continues the list from where the returning call left off.
- On success, responds with
DescribeBackupsOutput
with field(s):backups(Option<Vec::<Backup>>)
:An array of backups.
next_token(Option<String>)
:A
NextToken
value is present if there are more backups than returned in the response. You can use theNextToken
value in the subsequent request to fetch the backups.
- On failure, responds with
SdkError<DescribeBackupsError>
source§impl Client
impl Client
sourcepub fn describe_data_repository_associations(
&self
) -> DescribeDataRepositoryAssociationsFluentBuilder
pub fn describe_data_repository_associations( &self ) -> DescribeDataRepositoryAssociationsFluentBuilder
Constructs a fluent builder for the DescribeDataRepositoryAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
association_ids(impl Into<String>)
/set_association_ids(Option<Vec::<String>>)
:
required: falseIDs of the data repository associations whose descriptions you want to retrieve (String).
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseA list of
Filter
elements.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of resources to return in the response. This value must be an integer greater than zero.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On success, responds with
DescribeDataRepositoryAssociationsOutput
with field(s):associations(Option<Vec::<DataRepositoryAssociation>>)
:An array of one or more data repository association descriptions.
next_token(Option<String>)
:(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On failure, responds with
SdkError<DescribeDataRepositoryAssociationsError>
source§impl Client
impl Client
sourcepub fn describe_data_repository_tasks(
&self
) -> DescribeDataRepositoryTasksFluentBuilder
pub fn describe_data_repository_tasks( &self ) -> DescribeDataRepositoryTasksFluentBuilder
Constructs a fluent builder for the DescribeDataRepositoryTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
task_ids(impl Into<String>)
/set_task_ids(Option<Vec::<String>>)
:
required: false(Optional) IDs of the tasks whose descriptions you want to retrieve (String).
filters(DataRepositoryTaskFilter)
/set_filters(Option<Vec::<DataRepositoryTaskFilter>>)
:
required: false(Optional) You can use filters to narrow the
DescribeDataRepositoryTasks
response to include just tasks for specific file systems, or tasks in a specific lifecycle state.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of resources to return in the response. This value must be an integer greater than zero.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On success, responds with
DescribeDataRepositoryTasksOutput
with field(s):data_repository_tasks(Option<Vec::<DataRepositoryTask>>)
:The collection of data repository task descriptions returned.
next_token(Option<String>)
:(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On failure, responds with
SdkError<DescribeDataRepositoryTasksError>
source§impl Client
impl Client
sourcepub fn describe_file_caches(&self) -> DescribeFileCachesFluentBuilder
pub fn describe_file_caches(&self) -> DescribeFileCachesFluentBuilder
Constructs a fluent builder for the DescribeFileCaches
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
file_cache_ids(impl Into<String>)
/set_file_cache_ids(Option<Vec::<String>>)
:
required: falseIDs of the caches whose descriptions you want to retrieve (String).
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of resources to return in the response. This value must be an integer greater than zero.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On success, responds with
DescribeFileCachesOutput
with field(s):file_caches(Option<Vec::<FileCache>>)
:The response object for the
DescribeFileCaches
operation.next_token(Option<String>)
:(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On failure, responds with
SdkError<DescribeFileCachesError>
source§impl Client
impl Client
sourcepub fn describe_file_system_aliases(
&self
) -> DescribeFileSystemAliasesFluentBuilder
pub fn describe_file_system_aliases( &self ) -> DescribeFileSystemAliasesFluentBuilder
Constructs a fluent builder for the DescribeFileSystemAliases
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe ID of the file system to return the associated DNS aliases for (String).
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the
MaxResults
parameter specified in the request and the service’s internal maximum number of items per page.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOpaque pagination token returned from a previous
DescribeFileSystemAliases
operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.
- On success, responds with
DescribeFileSystemAliasesOutput
with field(s):aliases(Option<Vec::<Alias>>)
:An array of one or more DNS aliases currently associated with the specified file system.
next_token(Option<String>)
:Present if there are more DNS aliases than returned in the response (String). You can use the
NextToken
value in a later request to fetch additional descriptions.
- On failure, responds with
SdkError<DescribeFileSystemAliasesError>
source§impl Client
impl Client
sourcepub fn describe_file_systems(&self) -> DescribeFileSystemsFluentBuilder
pub fn describe_file_systems(&self) -> DescribeFileSystemsFluentBuilder
Constructs a fluent builder for the DescribeFileSystems
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
file_system_ids(impl Into<String>)
/set_file_system_ids(Option<Vec::<String>>)
:
required: falseIDs of the file systems whose descriptions you want to retrieve (String).
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the
MaxResults
parameter specified in the request and the service’s internal maximum number of items per page.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOpaque pagination token returned from a previous
DescribeFileSystems
operation (String). If a token present, the operation continues the list from where the returning call left off.
- On success, responds with
DescribeFileSystemsOutput
with field(s):file_systems(Option<Vec::<FileSystem>>)
:An array of file system descriptions.
next_token(Option<String>)
:Present if there are more file systems than returned in the response (String). You can use the
NextToken
value in the later request to fetch the descriptions.
- On failure, responds with
SdkError<DescribeFileSystemsError>
source§impl Client
impl Client
Constructs a fluent builder for the DescribeSharedVpcConfiguration
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeSharedVpcConfigurationOutput
with field(s):enable_fsx_route_table_updates_from_participant_accounts(Option<String>)
:Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets.
- On failure, responds with
SdkError<DescribeSharedVpcConfigurationError>
source§impl Client
impl Client
sourcepub fn describe_snapshots(&self) -> DescribeSnapshotsFluentBuilder
pub fn describe_snapshots(&self) -> DescribeSnapshotsFluentBuilder
Constructs a fluent builder for the DescribeSnapshots
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
snapshot_ids(impl Into<String>)
/set_snapshot_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren’t found, a
SnapshotNotFound
error occurs.filters(SnapshotFilter)
/set_filters(Option<Vec::<SnapshotFilter>>)
:
required: falseThe filters structure. The supported names are
file-system-id
orvolume-id
.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of resources to return in the response. This value must be an integer greater than zero.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.include_shared(bool)
/set_include_shared(Option<bool>)
:
required: falseSet to
false
(default) if you want to only see the snapshots owned by your Amazon Web Services account. Set totrue
if you want to see the snapshots in your account and the ones shared with you from another account.
- On success, responds with
DescribeSnapshotsOutput
with field(s):snapshots(Option<Vec::<Snapshot>>)
:An array of snapshots.
next_token(Option<String>)
:(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On failure, responds with
SdkError<DescribeSnapshotsError>
source§impl Client
impl Client
sourcepub fn describe_storage_virtual_machines(
&self
) -> DescribeStorageVirtualMachinesFluentBuilder
pub fn describe_storage_virtual_machines( &self ) -> DescribeStorageVirtualMachinesFluentBuilder
Constructs a fluent builder for the DescribeStorageVirtualMachines
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
storage_virtual_machine_ids(impl Into<String>)
/set_storage_virtual_machine_ids(Option<Vec::<String>>)
:
required: falseEnter the ID of one or more SVMs that you want to view.
filters(StorageVirtualMachineFilter)
/set_filters(Option<Vec::<StorageVirtualMachineFilter>>)
:
required: falseEnter a filter name:value pair to view a select set of SVMs.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of resources to return in the response. This value must be an integer greater than zero.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On success, responds with
DescribeStorageVirtualMachinesOutput
with field(s):storage_virtual_machines(Option<Vec::<StorageVirtualMachine>>)
:Returned after a successful
DescribeStorageVirtualMachines
operation, describing each SVM.next_token(Option<String>)
:(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On failure, responds with
SdkError<DescribeStorageVirtualMachinesError>
source§impl Client
impl Client
sourcepub fn describe_volumes(&self) -> DescribeVolumesFluentBuilder
pub fn describe_volumes(&self) -> DescribeVolumesFluentBuilder
Constructs a fluent builder for the DescribeVolumes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
volume_ids(impl Into<String>)
/set_volume_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the volumes whose descriptions you want to retrieve.
filters(VolumeFilter)
/set_filters(Option<Vec::<VolumeFilter>>)
:
required: falseEnter a filter
Name
andValues
pair to view a select set of volumes.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of resources to return in the response. This value must be an integer greater than zero.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On success, responds with
DescribeVolumesOutput
with field(s):volumes(Option<Vec::<Volume>>)
:Returned after a successful
DescribeVolumes
operation, describing each volume.next_token(Option<String>)
:(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextToken
value left off.
- On failure, responds with
SdkError<DescribeVolumesError>
source§impl Client
impl Client
sourcepub fn disassociate_file_system_aliases(
&self
) -> DisassociateFileSystemAliasesFluentBuilder
pub fn disassociate_file_system_aliases( &self ) -> DisassociateFileSystemAliasesFluentBuilder
Constructs a fluent builder for the DisassociateFileSystemAliases
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueSpecifies the file system from which to disassociate the DNS aliases.
aliases(impl Into<String>)
/set_aliases(Option<Vec::<String>>)
:
required: trueAn array of one or more DNS alias names to disassociate, or remove, from the file system.
- On success, responds with
DisassociateFileSystemAliasesOutput
with field(s):aliases(Option<Vec::<Alias>>)
:An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.
- On failure, responds with
SdkError<DisassociateFileSystemAliasesError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the Amazon FSx resource that will have its tags listed.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the
MaxResults
parameter specified in the request and the service’s internal maximum number of items per page.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOpaque pagination token returned from a previous
ListTagsForResource
operation (String). If a token present, the action continues the list from where the returning call left off.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:A list of tags on the resource.
next_token(Option<String>)
:This is present if there are more tags than returned in the response (String). You can use the
NextToken
value in the later request to fetch the tags.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn release_file_system_nfs_v3_locks(
&self
) -> ReleaseFileSystemNfsV3LocksFluentBuilder
pub fn release_file_system_nfs_v3_locks( &self ) -> ReleaseFileSystemNfsV3LocksFluentBuilder
Constructs a fluent builder for the ReleaseFileSystemNfsV3Locks
operation.
- The fluent builder is configurable:
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe globally unique ID of the file system, assigned by Amazon FSx.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
- On success, responds with
ReleaseFileSystemNfsV3LocksOutput
with field(s):file_system(Option<FileSystem>)
:A description of a specific Amazon FSx file system.
- On failure, responds with
SdkError<ReleaseFileSystemNfsV3LocksError>
source§impl Client
impl Client
sourcepub fn restore_volume_from_snapshot(
&self
) -> RestoreVolumeFromSnapshotFluentBuilder
pub fn restore_volume_from_snapshot( &self ) -> RestoreVolumeFromSnapshotFluentBuilder
Constructs a fluent builder for the RestoreVolumeFromSnapshot
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
volume_id(impl Into<String>)
/set_volume_id(Option<String>)
:
required: trueThe ID of the volume that you are restoring.
snapshot_id(impl Into<String>)
/set_snapshot_id(Option<String>)
:
required: trueThe ID of the source snapshot. Specifies the snapshot that you are restoring from.
options(RestoreOpenZfsVolumeOption)
/set_options(Option<Vec::<RestoreOpenZfsVolumeOption>>)
:
required: falseThe settings used when restoring the specified volume from snapshot.
-
DELETE_INTERMEDIATE_SNAPSHOTS
- Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn’t used,RestoreVolumeFromSnapshot
fails. -
DELETE_CLONED_VOLUMES
- Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn’t used,RestoreVolumeFromSnapshot
fails.
-
- On success, responds with
RestoreVolumeFromSnapshotOutput
with field(s):volume_id(Option<String>)
:The ID of the volume that you restored.
lifecycle(Option<VolumeLifecycle>)
:The lifecycle state of the volume being restored.
administrative_actions(Option<Vec::<AdministrativeAction>>)
:A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
- On failure, responds with
SdkError<RestoreVolumeFromSnapshotError>
source§impl Client
impl Client
sourcepub fn start_misconfigured_state_recovery(
&self
) -> StartMisconfiguredStateRecoveryFluentBuilder
pub fn start_misconfigured_state_recovery( &self ) -> StartMisconfiguredStateRecoveryFluentBuilder
Constructs a fluent builder for the StartMisconfiguredStateRecovery
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe globally unique ID of the file system, assigned by Amazon FSx.
- On success, responds with
StartMisconfiguredStateRecoveryOutput
with field(s):file_system(Option<FileSystem>)
:A description of a specific Amazon FSx file system.
- On failure, responds with
SdkError<StartMisconfiguredStateRecoveryError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the Amazon FSx resource to untag.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of keys of tags on the resource to untag. In case the tag key doesn’t exist, the call will still succeed to be idempotent.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_data_repository_association(
&self
) -> UpdateDataRepositoryAssociationFluentBuilder
pub fn update_data_repository_association( &self ) -> UpdateDataRepositoryAssociationFluentBuilder
Constructs a fluent builder for the UpdateDataRepositoryAssociation
operation.
- The fluent builder is configurable:
association_id(impl Into<String>)
/set_association_id(Option<String>)
:
required: trueThe ID of the data repository association that you are updating.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
imported_file_chunk_size(i32)
/set_imported_file_chunk_size(Option<i32>)
:
required: falseFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
s3(S3DataRepositoryConfiguration)
/set_s3(Option<S3DataRepositoryConfiguration>)
:
required: falseThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
- On success, responds with
UpdateDataRepositoryAssociationOutput
with field(s):association(Option<DataRepositoryAssociation>)
:The response object returned after the data repository association is updated.
- On failure, responds with
SdkError<UpdateDataRepositoryAssociationError>
source§impl Client
impl Client
sourcepub fn update_file_cache(&self) -> UpdateFileCacheFluentBuilder
pub fn update_file_cache(&self) -> UpdateFileCacheFluentBuilder
Constructs a fluent builder for the UpdateFileCache
operation.
- The fluent builder is configurable:
file_cache_id(impl Into<String>)
/set_file_cache_id(Option<String>)
:
required: trueThe ID of the cache that you are updating.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
lustre_configuration(UpdateFileCacheLustreConfiguration)
/set_lustre_configuration(Option<UpdateFileCacheLustreConfiguration>)
:
required: falseThe configuration updates for an Amazon File Cache resource.
- On success, responds with
UpdateFileCacheOutput
with field(s):file_cache(Option<FileCache>)
:A description of the cache that was updated.
- On failure, responds with
SdkError<UpdateFileCacheError>
source§impl Client
impl Client
sourcepub fn update_file_system(&self) -> UpdateFileSystemFluentBuilder
pub fn update_file_system(&self) -> UpdateFileSystemFluentBuilder
Constructs a fluent builder for the UpdateFileSystem
operation.
- The fluent builder is configurable:
file_system_id(impl Into<String>)
/set_file_system_id(Option<String>)
:
required: trueThe ID of the file system that you are updating.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
storage_capacity(i32)
/set_storage_capacity(Option<i32>)
:
required: falseUse this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you’re updating.
You can’t make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Lustre file systems, the storage capacity target value can be the following:
-
For
SCRATCH_2
,PERSISTENT_1
, andPERSISTENT_2 SSD
deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. -
For
PERSISTENT HDD
file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity. -
For
SCRATCH_1
file systems, you can’t increase the storage capacity.
For more information, see Managing storage and throughput capacity in the FSx for Lustre User Guide.
For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.
For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.
For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
-
windows_configuration(UpdateFileSystemWindowsConfiguration)
/set_windows_configuration(Option<UpdateFileSystemWindowsConfiguration>)
:
required: falseThe configuration updates for an Amazon FSx for Windows File Server file system.
lustre_configuration(UpdateFileSystemLustreConfiguration)
/set_lustre_configuration(Option<UpdateFileSystemLustreConfiguration>)
:
required: falseThe configuration object for Amazon FSx for Lustre file systems used in the
UpdateFileSystem
operation.ontap_configuration(UpdateFileSystemOntapConfiguration)
/set_ontap_configuration(Option<UpdateFileSystemOntapConfiguration>)
:
required: falseThe configuration updates for an Amazon FSx for NetApp ONTAP file system.
open_zfs_configuration(UpdateFileSystemOpenZfsConfiguration)
/set_open_zfs_configuration(Option<UpdateFileSystemOpenZfsConfiguration>)
:
required: falseThe configuration updates for an FSx for OpenZFS file system.
storage_type(StorageType)
/set_storage_type(Option<StorageType>)
:
required: falseSpecifies the file system’s storage type.
- On success, responds with
UpdateFileSystemOutput
with field(s):file_system(Option<FileSystem>)
:A description of the file system that was updated.
- On failure, responds with
SdkError<UpdateFileSystemError>
source§impl Client
impl Client
Constructs a fluent builder for the UpdateSharedVpcConfiguration
operation.
- The fluent builder is configurable:
enable_fsx_route_table_updates_from_participant_accounts(impl Into<String>)
/set_enable_fsx_route_table_updates_from_participant_accounts(Option<String>)
:
required: falseSpecifies whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Set to
true
to enable orfalse
to disable.client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
- On success, responds with
UpdateSharedVpcConfigurationOutput
with field(s):enable_fsx_route_table_updates_from_participant_accounts(Option<String>)
:Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets.
- On failure, responds with
SdkError<UpdateSharedVpcConfigurationError>
source§impl Client
impl Client
sourcepub fn update_snapshot(&self) -> UpdateSnapshotFluentBuilder
pub fn update_snapshot(&self) -> UpdateSnapshotFluentBuilder
Constructs a fluent builder for the UpdateSnapshot
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the snapshot to update.
snapshot_id(impl Into<String>)
/set_snapshot_id(Option<String>)
:
required: trueThe ID of the snapshot that you want to update, in the format
fsvolsnap-0123456789abcdef0
.
- On success, responds with
UpdateSnapshotOutput
with field(s):snapshot(Option<Snapshot>)
:Returned after a successful
UpdateSnapshot
operation, describing the snapshot that you updated.
- On failure, responds with
SdkError<UpdateSnapshotError>
source§impl Client
impl Client
sourcepub fn update_storage_virtual_machine(
&self
) -> UpdateStorageVirtualMachineFluentBuilder
pub fn update_storage_virtual_machine( &self ) -> UpdateStorageVirtualMachineFluentBuilder
Constructs a fluent builder for the UpdateStorageVirtualMachine
operation.
- The fluent builder is configurable:
active_directory_configuration(UpdateSvmActiveDirectoryConfiguration)
/set_active_directory_configuration(Option<UpdateSvmActiveDirectoryConfiguration>)
:
required: falseSpecifies updates to an SVM’s Microsoft Active Directory (AD) configuration.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
storage_virtual_machine_id(impl Into<String>)
/set_storage_virtual_machine_id(Option<String>)
:
required: trueThe ID of the SVM that you want to update, in the format
svm-0123456789abcdef0
.svm_admin_password(impl Into<String>)
/set_svm_admin_password(Option<String>)
:
required: falseSpecifies a new SvmAdminPassword.
- On success, responds with
UpdateStorageVirtualMachineOutput
with field(s):storage_virtual_machine(Option<StorageVirtualMachine>)
:Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.
- On failure, responds with
SdkError<UpdateStorageVirtualMachineError>
source§impl Client
impl Client
sourcepub fn update_volume(&self) -> UpdateVolumeFluentBuilder
pub fn update_volume(&self) -> UpdateVolumeFluentBuilder
Constructs a fluent builder for the UpdateVolume
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: false(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
volume_id(impl Into<String>)
/set_volume_id(Option<String>)
:
required: trueThe ID of the volume that you want to update, in the format
fsvol-0123456789abcdef0
.ontap_configuration(UpdateOntapVolumeConfiguration)
/set_ontap_configuration(Option<UpdateOntapVolumeConfiguration>)
:
required: falseThe configuration of the ONTAP volume that you are updating.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the OpenZFS volume. OpenZFS root volumes are automatically named
FSX
. Child volume names must be unique among their parent volume’s children. The name of the volume is part of the mount string for the OpenZFS volume.open_zfs_configuration(UpdateOpenZfsVolumeConfiguration)
/set_open_zfs_configuration(Option<UpdateOpenZfsVolumeConfiguration>)
:
required: falseThe configuration of the OpenZFS volume that you are updating.
- On success, responds with
UpdateVolumeOutput
with field(s):volume(Option<Volume>)
:A description of the volume just updated. Returned after a successful
UpdateVolume
API operation.
- On failure, responds with
SdkError<UpdateVolumeError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
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