aws_sdk_datasync/client/
create_location_fsx_windows.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateLocationFsxWindows`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`subdirectory(impl Into<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::subdirectory) / [`set_subdirectory(Option<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::set_subdirectory):<br>required: **false**<br><p>Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).</p><br>
    ///   - [`fsx_filesystem_arn(impl Into<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::fsx_filesystem_arn) / [`set_fsx_filesystem_arn(Option<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::set_fsx_filesystem_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.</p><br>
    ///   - [`security_group_arns(impl Into<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::security_group_arns) / [`set_security_group_arns(Option<Vec::<String>>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::set_security_group_arns):<br>required: **true**<br><p>Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.</p> <p>The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html"> <i>Amazon FSx for Windows File Server User Guide</i> </a>.</p><note>  <p>If you choose a security group that doesn't allow connections from within itself, do one of the following:</p>  <ul>   <li>    <p>Configure the security group to allow it to communicate within itself.</p></li>   <li>    <p>Choose a different security group that can communicate with the mount target's security group.</p></li>  </ul> </note><br>
    ///   - [`tags(TagListEntry)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::tags) / [`set_tags(Option<Vec::<TagListEntry>>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::set_tags):<br>required: **false**<br><p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p><br>
    ///   - [`user(impl Into<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::user) / [`set_user(Option<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::set_user):<br>required: **true**<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>
    ///   - [`domain(impl Into<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::set_domain):<br>required: **false**<br><p>Specifies the name of the Windows domain that the 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>
    ///   - [`password(impl Into<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::password) / [`set_password(Option<String>)`](crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::set_password):<br>required: **true**<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>
    /// - On success, responds with [`CreateLocationFsxWindowsOutput`](crate::operation::create_location_fsx_windows::CreateLocationFsxWindowsOutput) with field(s):
    ///   - [`location_arn(Option<String>)`](crate::operation::create_location_fsx_windows::CreateLocationFsxWindowsOutput::location_arn): <p>The ARN of the FSx for Windows File Server file system location you created.</p>
    /// - On failure, responds with [`SdkError<CreateLocationFsxWindowsError>`](crate::operation::create_location_fsx_windows::CreateLocationFsxWindowsError)
    pub fn create_location_fsx_windows(&self) -> crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder {
        crate::operation::create_location_fsx_windows::builders::CreateLocationFsxWindowsFluentBuilder::new(self.handle.clone())
    }
}