aws-sdk-datasync 1.111.0

AWS SDK for AWS DataSync
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>DescribeLocationSmbResponse</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeLocationSmbOutput {
    /// <p>The ARN of the SMB location.</p>
    pub location_arn: ::std::option::Option<::std::string::String>,
    /// <p>The URI of the SMB location.</p>
    pub location_uri: ::std::option::Option<::std::string::String>,
    /// <p>The ARNs of the DataSync agents that can connect with your SMB file server.</p>
    pub agent_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub user: ::std::option::Option<::std::string::String>,
    /// <p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub domain: ::std::option::Option<::std::string::String>,
    /// <p>The SMB protocol version that DataSync uses to access your SMB file server.</p>
    pub mount_options: ::std::option::Option<crate::types::SmbMountOptions>,
    /// <p>The time that the SMB location was created.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>
    pub dns_ip_addresses: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>
    pub kerberos_principal: ::std::option::Option<::std::string::String>,
    /// <p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>
    pub authentication_type: ::std::option::Option<crate::types::SmbAuthenticationType>,
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub managed_secret_config: ::std::option::Option<crate::types::ManagedSecretConfig>,
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> that DataSync uses to access a specific storage location, with a customer-managed KMS key.</p>
    pub cmk_secret_config: ::std::option::Option<crate::types::CmkSecretConfig>,
    /// <p>Describes configuration information for a customer-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub custom_secret_config: ::std::option::Option<crate::types::CustomSecretConfig>,
    _request_id: Option<String>,
}
impl DescribeLocationSmbOutput {
    /// <p>The ARN of the SMB location.</p>
    pub fn location_arn(&self) -> ::std::option::Option<&str> {
        self.location_arn.as_deref()
    }
    /// <p>The URI of the SMB location.</p>
    pub fn location_uri(&self) -> ::std::option::Option<&str> {
        self.location_uri.as_deref()
    }
    /// <p>The ARNs of the DataSync agents that can connect with your SMB file server.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.agent_arns.is_none()`.
    pub fn agent_arns(&self) -> &[::std::string::String] {
        self.agent_arns.as_deref().unwrap_or_default()
    }
    /// <p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn user(&self) -> ::std::option::Option<&str> {
        self.user.as_deref()
    }
    /// <p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn domain(&self) -> ::std::option::Option<&str> {
        self.domain.as_deref()
    }
    /// <p>The SMB protocol version that DataSync uses to access your SMB file server.</p>
    pub fn mount_options(&self) -> ::std::option::Option<&crate::types::SmbMountOptions> {
        self.mount_options.as_ref()
    }
    /// <p>The time that the SMB location was created.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.as_ref()
    }
    /// <p>The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.dns_ip_addresses.is_none()`.
    pub fn dns_ip_addresses(&self) -> &[::std::string::String] {
        self.dns_ip_addresses.as_deref().unwrap_or_default()
    }
    /// <p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>
    pub fn kerberos_principal(&self) -> ::std::option::Option<&str> {
        self.kerberos_principal.as_deref()
    }
    /// <p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>
    pub fn authentication_type(&self) -> ::std::option::Option<&crate::types::SmbAuthenticationType> {
        self.authentication_type.as_ref()
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn managed_secret_config(&self) -> ::std::option::Option<&crate::types::ManagedSecretConfig> {
        self.managed_secret_config.as_ref()
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> that DataSync uses to access a specific storage location, with a customer-managed KMS key.</p>
    pub fn cmk_secret_config(&self) -> ::std::option::Option<&crate::types::CmkSecretConfig> {
        self.cmk_secret_config.as_ref()
    }
    /// <p>Describes configuration information for a customer-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn custom_secret_config(&self) -> ::std::option::Option<&crate::types::CustomSecretConfig> {
        self.custom_secret_config.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for DescribeLocationSmbOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DescribeLocationSmbOutput {
    /// Creates a new builder-style object to manufacture [`DescribeLocationSmbOutput`](crate::operation::describe_location_smb::DescribeLocationSmbOutput).
    pub fn builder() -> crate::operation::describe_location_smb::builders::DescribeLocationSmbOutputBuilder {
        crate::operation::describe_location_smb::builders::DescribeLocationSmbOutputBuilder::default()
    }
}

/// A builder for [`DescribeLocationSmbOutput`](crate::operation::describe_location_smb::DescribeLocationSmbOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeLocationSmbOutputBuilder {
    pub(crate) location_arn: ::std::option::Option<::std::string::String>,
    pub(crate) location_uri: ::std::option::Option<::std::string::String>,
    pub(crate) agent_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) user: ::std::option::Option<::std::string::String>,
    pub(crate) domain: ::std::option::Option<::std::string::String>,
    pub(crate) mount_options: ::std::option::Option<crate::types::SmbMountOptions>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) dns_ip_addresses: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) kerberos_principal: ::std::option::Option<::std::string::String>,
    pub(crate) authentication_type: ::std::option::Option<crate::types::SmbAuthenticationType>,
    pub(crate) managed_secret_config: ::std::option::Option<crate::types::ManagedSecretConfig>,
    pub(crate) cmk_secret_config: ::std::option::Option<crate::types::CmkSecretConfig>,
    pub(crate) custom_secret_config: ::std::option::Option<crate::types::CustomSecretConfig>,
    _request_id: Option<String>,
}
impl DescribeLocationSmbOutputBuilder {
    /// <p>The ARN of the SMB location.</p>
    pub fn location_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.location_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the SMB location.</p>
    pub fn set_location_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.location_arn = input;
        self
    }
    /// <p>The ARN of the SMB location.</p>
    pub fn get_location_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.location_arn
    }
    /// <p>The URI of the SMB location.</p>
    pub fn location_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.location_uri = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The URI of the SMB location.</p>
    pub fn set_location_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.location_uri = input;
        self
    }
    /// <p>The URI of the SMB location.</p>
    pub fn get_location_uri(&self) -> &::std::option::Option<::std::string::String> {
        &self.location_uri
    }
    /// Appends an item to `agent_arns`.
    ///
    /// To override the contents of this collection use [`set_agent_arns`](Self::set_agent_arns).
    ///
    /// <p>The ARNs of the DataSync agents that can connect with your SMB file server.</p>
    pub fn agent_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.agent_arns.unwrap_or_default();
        v.push(input.into());
        self.agent_arns = ::std::option::Option::Some(v);
        self
    }
    /// <p>The ARNs of the DataSync agents that can connect with your SMB file server.</p>
    pub fn set_agent_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.agent_arns = input;
        self
    }
    /// <p>The ARNs of the DataSync agents that can connect with your SMB file server.</p>
    pub fn get_agent_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.agent_arns
    }
    /// <p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn user(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.user = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn set_user(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.user = input;
        self
    }
    /// <p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn get_user(&self) -> &::std::option::Option<::std::string::String> {
        &self.user
    }
    /// <p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn domain(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn set_domain(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain = input;
        self
    }
    /// <p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
    pub fn get_domain(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain
    }
    /// <p>The SMB protocol version that DataSync uses to access your SMB file server.</p>
    pub fn mount_options(mut self, input: crate::types::SmbMountOptions) -> Self {
        self.mount_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>The SMB protocol version that DataSync uses to access your SMB file server.</p>
    pub fn set_mount_options(mut self, input: ::std::option::Option<crate::types::SmbMountOptions>) -> Self {
        self.mount_options = input;
        self
    }
    /// <p>The SMB protocol version that DataSync uses to access your SMB file server.</p>
    pub fn get_mount_options(&self) -> &::std::option::Option<crate::types::SmbMountOptions> {
        &self.mount_options
    }
    /// <p>The time that the SMB location was created.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time that the SMB location was created.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>The time that the SMB location was created.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// Appends an item to `dns_ip_addresses`.
    ///
    /// To override the contents of this collection use [`set_dns_ip_addresses`](Self::set_dns_ip_addresses).
    ///
    /// <p>The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>
    pub fn dns_ip_addresses(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.dns_ip_addresses.unwrap_or_default();
        v.push(input.into());
        self.dns_ip_addresses = ::std::option::Option::Some(v);
        self
    }
    /// <p>The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>
    pub fn set_dns_ip_addresses(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.dns_ip_addresses = input;
        self
    }
    /// <p>The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>
    pub fn get_dns_ip_addresses(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.dns_ip_addresses
    }
    /// <p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>
    pub fn kerberos_principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.kerberos_principal = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>
    pub fn set_kerberos_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.kerberos_principal = input;
        self
    }
    /// <p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>
    pub fn get_kerberos_principal(&self) -> &::std::option::Option<::std::string::String> {
        &self.kerberos_principal
    }
    /// <p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>
    pub fn authentication_type(mut self, input: crate::types::SmbAuthenticationType) -> Self {
        self.authentication_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>
    pub fn set_authentication_type(mut self, input: ::std::option::Option<crate::types::SmbAuthenticationType>) -> Self {
        self.authentication_type = input;
        self
    }
    /// <p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>
    pub fn get_authentication_type(&self) -> &::std::option::Option<crate::types::SmbAuthenticationType> {
        &self.authentication_type
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn managed_secret_config(mut self, input: crate::types::ManagedSecretConfig) -> Self {
        self.managed_secret_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn set_managed_secret_config(mut self, input: ::std::option::Option<crate::types::ManagedSecretConfig>) -> Self {
        self.managed_secret_config = input;
        self
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn get_managed_secret_config(&self) -> &::std::option::Option<crate::types::ManagedSecretConfig> {
        &self.managed_secret_config
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> that DataSync uses to access a specific storage location, with a customer-managed KMS key.</p>
    pub fn cmk_secret_config(mut self, input: crate::types::CmkSecretConfig) -> Self {
        self.cmk_secret_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> that DataSync uses to access a specific storage location, with a customer-managed KMS key.</p>
    pub fn set_cmk_secret_config(mut self, input: ::std::option::Option<crate::types::CmkSecretConfig>) -> Self {
        self.cmk_secret_config = input;
        self
    }
    /// <p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> that DataSync uses to access a specific storage location, with a customer-managed KMS key.</p>
    pub fn get_cmk_secret_config(&self) -> &::std::option::Option<crate::types::CmkSecretConfig> {
        &self.cmk_secret_config
    }
    /// <p>Describes configuration information for a customer-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn custom_secret_config(mut self, input: crate::types::CustomSecretConfig) -> Self {
        self.custom_secret_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes configuration information for a customer-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn set_custom_secret_config(mut self, input: ::std::option::Option<crate::types::CustomSecretConfig>) -> Self {
        self.custom_secret_config = input;
        self
    }
    /// <p>Describes configuration information for a customer-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</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>
    pub fn get_custom_secret_config(&self) -> &::std::option::Option<crate::types::CustomSecretConfig> {
        &self.custom_secret_config
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`DescribeLocationSmbOutput`](crate::operation::describe_location_smb::DescribeLocationSmbOutput).
    pub fn build(self) -> crate::operation::describe_location_smb::DescribeLocationSmbOutput {
        crate::operation::describe_location_smb::DescribeLocationSmbOutput {
            location_arn: self.location_arn,
            location_uri: self.location_uri,
            agent_arns: self.agent_arns,
            user: self.user,
            domain: self.domain,
            mount_options: self.mount_options,
            creation_time: self.creation_time,
            dns_ip_addresses: self.dns_ip_addresses,
            kerberos_principal: self.kerberos_principal,
            authentication_type: self.authentication_type,
            managed_secret_config: self.managed_secret_config,
            cmk_secret_config: self.cmk_secret_config,
            custom_secret_config: self.custom_secret_config,
            _request_id: self._request_id,
        }
    }
}