FsxProtocolSmb (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.datasync.model.FsxProtocolSmb

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FsxProtocolSmb
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see Accessing FSx for ONTAP file systems.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FsxProtocolSmb()

Constructors
Constructor and Description
`FsxProtocolSmb()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FsxProtocolSmb`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDomain()` Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
`SmbMountOptions`	`getMountOptions()`
`String`	`getPassword()` Specifies the password of a user who has permission to access your SVM.
`String`	`getUser()` Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDomain(String domain)` Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
`void`	`setMountOptions(SmbMountOptions mountOptions)`
`void`	`setPassword(String password)` Specifies the password of a user who has permission to access your SVM.
`void`	`setUser(String user)` Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
`String`	`toString()` Returns a string representation of this object.
`FsxProtocolSmb`	`withDomain(String domain)` Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
`FsxProtocolSmb`	`withMountOptions(SmbMountOptions mountOptions)`
`FsxProtocolSmb`	`withPassword(String password)` Specifies the password of a user who has permission to access your SVM.
`FsxProtocolSmb`	`withUser(String user)` Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FsxProtocolSmb
```
public FsxProtocolSmb()
```
- Method Detail
  - setDomain
```
public void setDomain(String domain)
```
    Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
    
    Parameters:
    
    domain - Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
  - getDomain
```
public String getDomain()
```
    Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
    
    Returns:
    
    Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
  - withDomain
```
public FsxProtocolSmb withDomain(String domain)
```
    Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
    
    Parameters:
    
    domain - Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMountOptions
```
public void setMountOptions(SmbMountOptions mountOptions)
```
    Parameters:
    
    mountOptions -
  - getMountOptions
```
public SmbMountOptions getMountOptions()
```
    Returns:
  - withMountOptions
```
public FsxProtocolSmb withMountOptions(SmbMountOptions mountOptions)
```
    Parameters:
    
    mountOptions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(String password)
```
    Specifies the password of a user who has permission to access your SVM.
    
    Parameters:
    
    password - Specifies the password of a user who has permission to access your SVM.
  - getPassword
```
public String getPassword()
```
    Specifies the password of a user who has permission to access your SVM.
    
    Returns:
    
    Specifies the password of a user who has permission to access your SVM.
  - withPassword
```
public FsxProtocolSmb withPassword(String password)
```
    Specifies the password of a user who has permission to access your SVM.
    
    Parameters:
    
    password - Specifies the password of a user who has permission to access your SVM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUser
```
public void setUser(String user)
```
    Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
    
    If you provide a user in your Active Directory, note the following:
    - If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
    - If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
    Make sure that the user has the permissions it needs to copy the data you want:
    - SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
    - SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
    Parameters:
    user - Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
    
    If you provide a user in your Active Directory, note the following:
    
    If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
    
    If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
    
    Make sure that the user has the permissions it needs to copy the data you want:
    
    SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
    
    SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
  - getUser
```
public String getUser()
```
    Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
    
    If you provide a user in your Active Directory, note the following:
    - If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
    - If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
    Make sure that the user has the permissions it needs to copy the data you want:
    - SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
    - SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
    Returns:
    Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
    
    If you provide a user in your Active Directory, note the following:
    
    If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
    
    If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
    
    Make sure that the user has the permissions it needs to copy the data you want:
    
    SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
    
    SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
  - withUser
```
public FsxProtocolSmb withUser(String user)
```
    Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
    
    If you provide a user in your Active Directory, note the following:
    - If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
    - If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
    Make sure that the user has the permissions it needs to copy the data you want:
    - SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
    - SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
    Parameters:
    user - Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
    
    If you provide a user in your Active Directory, note the following:
    
    If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
    
    If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
    
    Make sure that the user has the permissions it needs to copy the data you want:
    
    SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
    
    SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FsxProtocolSmb clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class FsxProtocolSmb

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FsxProtocolSmb

Method Detail

setDomain

getDomain

withDomain

setMountOptions

getMountOptions

withMountOptions

setPassword

getPassword

withPassword

setUser

getUser

withUser

toString

equals

hashCode

clone

marshall