Skip to main content

aws_sdk_datasync/client/
update_location_fsx_windows.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateLocationFsxWindows`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`location_arn(impl Into<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::location_arn) / [`set_location_arn(Option<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::set_location_arn):<br>required: **true**<br><p>Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.</p><br>
7    ///   - [`subdirectory(impl Into<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::subdirectory) / [`set_subdirectory(Option<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::set_subdirectory):<br>required: **false**<br><p>Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).</p><br>
8    ///   - [`domain(impl Into<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::set_domain):<br>required: **false**<br><p>Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.</p> <p>If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.</p><br>
9    ///   - [`user(impl Into<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::user) / [`set_user(Option<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::set_user):<br>required: **false**<br><p>Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p><br>
10    ///   - [`password(impl Into<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::password) / [`set_password(Option<String>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::set_password):<br>required: **false**<br><p>Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.</p><br>
11    ///   - [`cmk_secret_config(CmkSecretConfig)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::cmk_secret_config) / [`set_cmk_secret_config(Option<CmkSecretConfig>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::set_cmk_secret_config):<br>required: **false**<br><p>Specifies configuration information for a DataSync-managed secret, such as a <code>Password</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.</p><br>
12    ///   - [`custom_secret_config(CustomSecretConfig)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::custom_secret_config) / [`set_custom_secret_config(Option<CustomSecretConfig>)`](crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::set_custom_secret_config):<br>required: **false**<br><p>Specifies configuration information for a customer-managed secret, such as a <code>Password</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.</p><br>
13    /// - On success, responds with [`UpdateLocationFsxWindowsOutput`](crate::operation::update_location_fsx_windows::UpdateLocationFsxWindowsOutput)
14    /// - On failure, responds with [`SdkError<UpdateLocationFsxWindowsError>`](crate::operation::update_location_fsx_windows::UpdateLocationFsxWindowsError)
15    pub fn update_location_fsx_windows(&self) -> crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder {
16        crate::operation::update_location_fsx_windows::builders::UpdateLocationFsxWindowsFluentBuilder::new(self.handle.clone())
17    }
18}