@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeSMBSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeSMBSettingsResult() |
Modifier and Type | Method and Description |
---|---|
DescribeSMBSettingsResult |
clone() |
boolean |
equals(Object obj) |
String |
getActiveDirectoryStatus()
Indicates the status of a gateway that is a member of the Active Directory domain.
|
String |
getDomainName()
The name of the domain that the gateway is joined to.
|
Boolean |
getFileSharesVisible()
The shares on this gateway appear when listing shares.
|
String |
getGatewayARN() |
Boolean |
getSMBGuestPasswordSet()
This value is
true if a password for the guest user smbguest is set, otherwise
false . |
SMBLocalGroups |
getSMBLocalGroups()
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
|
String |
getSMBSecurityStrategy()
The type of security strategy that was specified for file gateway.
|
int |
hashCode() |
Boolean |
isFileSharesVisible()
The shares on this gateway appear when listing shares.
|
Boolean |
isSMBGuestPasswordSet()
This value is
true if a password for the guest user smbguest is set, otherwise
false . |
void |
setActiveDirectoryStatus(String activeDirectoryStatus)
Indicates the status of a gateway that is a member of the Active Directory domain.
|
void |
setDomainName(String domainName)
The name of the domain that the gateway is joined to.
|
void |
setFileSharesVisible(Boolean fileSharesVisible)
The shares on this gateway appear when listing shares.
|
void |
setGatewayARN(String gatewayARN) |
void |
setSMBGuestPasswordSet(Boolean sMBGuestPasswordSet)
This value is
true if a password for the guest user smbguest is set, otherwise
false . |
void |
setSMBLocalGroups(SMBLocalGroups sMBLocalGroups)
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
|
void |
setSMBSecurityStrategy(String sMBSecurityStrategy)
The type of security strategy that was specified for file gateway.
|
String |
toString()
Returns a string representation of this object.
|
DescribeSMBSettingsResult |
withActiveDirectoryStatus(ActiveDirectoryStatus activeDirectoryStatus)
Indicates the status of a gateway that is a member of the Active Directory domain.
|
DescribeSMBSettingsResult |
withActiveDirectoryStatus(String activeDirectoryStatus)
Indicates the status of a gateway that is a member of the Active Directory domain.
|
DescribeSMBSettingsResult |
withDomainName(String domainName)
The name of the domain that the gateway is joined to.
|
DescribeSMBSettingsResult |
withFileSharesVisible(Boolean fileSharesVisible)
The shares on this gateway appear when listing shares.
|
DescribeSMBSettingsResult |
withGatewayARN(String gatewayARN) |
DescribeSMBSettingsResult |
withSMBGuestPasswordSet(Boolean sMBGuestPasswordSet)
This value is
true if a password for the guest user smbguest is set, otherwise
false . |
DescribeSMBSettingsResult |
withSMBLocalGroups(SMBLocalGroups sMBLocalGroups)
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
|
DescribeSMBSettingsResult |
withSMBSecurityStrategy(SMBSecurityStrategy sMBSecurityStrategy)
The type of security strategy that was specified for file gateway.
|
DescribeSMBSettingsResult |
withSMBSecurityStrategy(String sMBSecurityStrategy)
The type of security strategy that was specified for file gateway.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setGatewayARN(String gatewayARN)
gatewayARN
- public String getGatewayARN()
public DescribeSMBSettingsResult withGatewayARN(String gatewayARN)
gatewayARN
- public void setDomainName(String domainName)
The name of the domain that the gateway is joined to.
domainName
- The name of the domain that the gateway is joined to.public String getDomainName()
The name of the domain that the gateway is joined to.
public DescribeSMBSettingsResult withDomainName(String domainName)
The name of the domain that the gateway is joined to.
domainName
- The name of the domain that the gateway is joined to.public void setActiveDirectoryStatus(String activeDirectoryStatus)
Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an authentication
error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation didn't
complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another type of
error.
activeDirectoryStatus
- Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an
authentication error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation
didn't complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another
type of error.
ActiveDirectoryStatus
public String getActiveDirectoryStatus()
Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an authentication
error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation didn't
complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another type of
error.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an
authentication error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation
didn't complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another
type of error.
ActiveDirectoryStatus
public DescribeSMBSettingsResult withActiveDirectoryStatus(String activeDirectoryStatus)
Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an authentication
error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation didn't
complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another type of
error.
activeDirectoryStatus
- Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an
authentication error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation
didn't complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another
type of error.
ActiveDirectoryStatus
public DescribeSMBSettingsResult withActiveDirectoryStatus(ActiveDirectoryStatus activeDirectoryStatus)
Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an authentication
error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation didn't
complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another type of
error.
activeDirectoryStatus
- Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED
: Indicates that the JoinDomain
operation failed due to an
authentication error.
DETACHED
: Indicates that gateway is not joined to a domain.
JOINED
: Indicates that the gateway has successfully joined a domain.
JOINING
: Indicates that a JoinDomain
operation is in progress.
NETWORK_ERROR
: Indicates that JoinDomain
operation failed due to a network or
connectivity error.
TIMEOUT
: Indicates that the JoinDomain
operation failed because the operation
didn't complete within the allotted time.
UNKNOWN_ERROR
: Indicates that the JoinDomain
operation failed due to another
type of error.
ActiveDirectoryStatus
public void setSMBGuestPasswordSet(Boolean sMBGuestPasswordSet)
This value is true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
sMBGuestPasswordSet
- This value is true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
public Boolean getSMBGuestPasswordSet()
This value is true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
public DescribeSMBSettingsResult withSMBGuestPasswordSet(Boolean sMBGuestPasswordSet)
This value is true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
sMBGuestPasswordSet
- This value is true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
public Boolean isSMBGuestPasswordSet()
This value is true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
true
if a password for the guest user smbguest
is set, otherwise
false
. Only supported for S3 File Gateways.
Valid Values: true
| false
public void setSMBSecurityStrategy(String sMBSecurityStrategy)
The type of security strategy that was specified for file gateway.
ClientSpecified
: If you choose this option, requests are established based on what is negotiated by
the client. This option is recommended when you want to maximize compatibility across different clients in your
environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2 or
SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows
Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from SMBv3
clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
sMBSecurityStrategy
- The type of security strategy that was specified for file gateway.
ClientSpecified
: If you choose this option, requests are established based on what is
negotiated by the client. This option is recommended when you want to maximize compatibility across
different clients in your environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2
or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows
Vista, Windows Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option
is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows
8, Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections
from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This
option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft
Windows 8, Windows Server 2012, or later.
SMBSecurityStrategy
public String getSMBSecurityStrategy()
The type of security strategy that was specified for file gateway.
ClientSpecified
: If you choose this option, requests are established based on what is negotiated by
the client. This option is recommended when you want to maximize compatibility across different clients in your
environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2 or
SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows
Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from SMBv3
clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
ClientSpecified
: If you choose this option, requests are established based on what is
negotiated by the client. This option is recommended when you want to maximize compatibility across
different clients in your environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2
or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows
Vista, Windows Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This
option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft
Windows 8, Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections
from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This
option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft
Windows 8, Windows Server 2012, or later.
SMBSecurityStrategy
public DescribeSMBSettingsResult withSMBSecurityStrategy(String sMBSecurityStrategy)
The type of security strategy that was specified for file gateway.
ClientSpecified
: If you choose this option, requests are established based on what is negotiated by
the client. This option is recommended when you want to maximize compatibility across different clients in your
environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2 or
SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows
Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from SMBv3
clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
sMBSecurityStrategy
- The type of security strategy that was specified for file gateway.
ClientSpecified
: If you choose this option, requests are established based on what is
negotiated by the client. This option is recommended when you want to maximize compatibility across
different clients in your environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2
or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows
Vista, Windows Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option
is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows
8, Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections
from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This
option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft
Windows 8, Windows Server 2012, or later.
SMBSecurityStrategy
public DescribeSMBSettingsResult withSMBSecurityStrategy(SMBSecurityStrategy sMBSecurityStrategy)
The type of security strategy that was specified for file gateway.
ClientSpecified
: If you choose this option, requests are established based on what is negotiated by
the client. This option is recommended when you want to maximize compatibility across different clients in your
environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2 or
SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows
Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from SMBv3
clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8,
Windows Server 2012, or later.
sMBSecurityStrategy
- The type of security strategy that was specified for file gateway.
ClientSpecified
: If you choose this option, requests are established based on what is
negotiated by the client. This option is recommended when you want to maximize compatibility across
different clients in your environment. Supported only for S3 File Gateway.
MandatorySigning
: If you choose this option, File Gateway only allows connections from SMBv2
or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows
Vista, Windows Server 2008, or later.
MandatoryEncryption
: If you choose this option, File Gateway only allows connections from
SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option
is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows
8, Windows Server 2012, or later.
MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only allows connections
from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This
option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft
Windows 8, Windows Server 2012, or later.
SMBSecurityStrategy
public void setFileSharesVisible(Boolean fileSharesVisible)
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
fileSharesVisible
- The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.public Boolean getFileSharesVisible()
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
public DescribeSMBSettingsResult withFileSharesVisible(Boolean fileSharesVisible)
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
fileSharesVisible
- The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.public Boolean isFileSharesVisible()
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
public void setSMBLocalGroups(SMBLocalGroups sMBLocalGroups)
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
sMBLocalGroups
- A list of Active Directory users and groups that have special permissions for SMB file shares on the
gateway.public SMBLocalGroups getSMBLocalGroups()
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
public DescribeSMBSettingsResult withSMBLocalGroups(SMBLocalGroups sMBLocalGroups)
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
sMBLocalGroups
- A list of Active Directory users and groups that have special permissions for SMB file shares on the
gateway.public String toString()
toString
in class Object
Object.toString()
public DescribeSMBSettingsResult clone()