Skip to main content

aws_sdk_datasync/client/
describe_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 [`DescribeLocationFsxWindows`](crate::operation::describe_location_fsx_windows::builders::DescribeLocationFsxWindowsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`location_arn(impl Into<String>)`](crate::operation::describe_location_fsx_windows::builders::DescribeLocationFsxWindowsFluentBuilder::location_arn) / [`set_location_arn(Option<String>)`](crate::operation::describe_location_fsx_windows::builders::DescribeLocationFsxWindowsFluentBuilder::set_location_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.</p><br>
7    /// - On success, responds with [`DescribeLocationFsxWindowsOutput`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput) with field(s):
8    ///   - [`location_arn(Option<String>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::location_arn): <p>The ARN of the FSx for Windows File Server location.</p>
9    ///   - [`location_uri(Option<String>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::location_uri): <p>The uniform resource identifier (URI) of the FSx for Windows File Server location.</p>
10    ///   - [`security_group_arns(Option<Vec::<String>>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::security_group_arns): <p>The ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.</p> <p>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>
11    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::creation_time): <p>The time that the FSx for Windows File Server location was created.</p>
12    ///   - [`user(Option<String>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::user): <p>The user with the permissions to mount and access the FSx for Windows File Server file system.</p>
13    ///   - [`domain(Option<String>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::domain): <p>The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.</p>
14    ///   - [`managed_secret_config(Option<ManagedSecretConfig>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::managed_secret_config): <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.</p>
15    ///   - [`cmk_secret_config(Option<CmkSecretConfig>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::cmk_secret_config): <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> that DataSync uses to access a specific storage location, with a customer-managed KMS key.</p>
16    ///   - [`custom_secret_config(Option<CustomSecretConfig>)`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsOutput::custom_secret_config): <p>Describes configuration information for a customer-managed secret, such as a <code>Password</code> that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.</p>
17    /// - On failure, responds with [`SdkError<DescribeLocationFsxWindowsError>`](crate::operation::describe_location_fsx_windows::DescribeLocationFsxWindowsError)
18    pub fn describe_location_fsx_windows(
19        &self,
20    ) -> crate::operation::describe_location_fsx_windows::builders::DescribeLocationFsxWindowsFluentBuilder {
21        crate::operation::describe_location_fsx_windows::builders::DescribeLocationFsxWindowsFluentBuilder::new(self.handle.clone())
22    }
23}