Struct UpdateLocationSmbInput

#[non_exhaustive]
pub struct UpdateLocationSmbInput {
    pub location_arn: Option<String>,
    pub subdirectory: Option<String>,
    pub user: Option<String>,
    pub domain: Option<String>,
    pub password: Option<String>,
    pub agent_arns: Option<Vec<String>>,
    pub mount_options: Option<SmbMountOptions>,
    pub authentication_type: Option<SmbAuthenticationType>,
    pub dns_ip_addresses: Option<Vec<String>>,
    pub kerberos_principal: Option<String>,
    pub kerberos_keytab: Option<Blob>,
    pub kerberos_krb5_conf: Option<Blob>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

location_arn: Option<String>

Specifies the ARN of the SMB location that you want to update.

subdirectory: Option<String>

Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.

user: Option<String>

Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.

domain: Option<String>

Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

password: Option<String>

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

agent_arns: Option<Vec<String>>

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

mount_options: Option<SmbMountOptions>

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

authentication_type: Option<SmbAuthenticationType>

Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.

dns_ip_addresses: Option<Vec<String>>

Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

kerberos_principal: Option<String>

Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

A Kerberos principal might look like HOST/kerberosuser@EXAMPLE.COM.

Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.

kerberos_keytab: Option<Blob>

Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.

kerberos_krb5_conf: Option<Blob>

Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration.

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

Implementations

impl UpdateLocationSmbInput

pub fn location_arn(&self) -> Option<&str>

Specifies the ARN of the SMB location that you want to update.

pub fn subdirectory(&self) -> Option<&str>

Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.

pub fn user(&self) -> Option<&str>

Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.

pub fn domain(&self) -> Option<&str>

Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

pub fn password(&self) -> Option<&str>

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

pub fn agent_arns(&self) -> &[String]

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

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 mount_options(&self) -> Option<&SmbMountOptions>

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

pub fn authentication_type(&self) -> Option<&SmbAuthenticationType>

Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.

pub fn dns_ip_addresses(&self) -> &[String]

Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

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 kerberos_principal(&self) -> Option<&str>

Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

A Kerberos principal might look like HOST/kerberosuser@EXAMPLE.COM.

Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.

pub fn kerberos_keytab(&self) -> Option<&Blob>

Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.

pub fn kerberos_krb5_conf(&self) -> Option<&Blob>

Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration.

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

impl UpdateLocationSmbInput

pub fn builder() -> UpdateLocationSmbInputBuilder

Creates a new builder-style object to manufacture UpdateLocationSmbInput.

Trait Implementations

impl Clone for UpdateLocationSmbInput

fn clone(&self) -> UpdateLocationSmbInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateLocationSmbInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateLocationSmbInput

fn eq(&self, other: &UpdateLocationSmbInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateLocationSmbInput