AWS SDK for C++  1.9.70
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::DescribeSMBSettingsResult Class Reference

#include <DescribeSMBSettingsResult.h>

Public Member Functions

 DescribeSMBSettingsResult ()
 
 DescribeSMBSettingsResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeSMBSettingsResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetGatewayARN () const
 
void SetGatewayARN (const Aws::String &value)
 
void SetGatewayARN (Aws::String &&value)
 
void SetGatewayARN (const char *value)
 
DescribeSMBSettingsResultWithGatewayARN (const Aws::String &value)
 
DescribeSMBSettingsResultWithGatewayARN (Aws::String &&value)
 
DescribeSMBSettingsResultWithGatewayARN (const char *value)
 
const Aws::StringGetDomainName () const
 
void SetDomainName (const Aws::String &value)
 
void SetDomainName (Aws::String &&value)
 
void SetDomainName (const char *value)
 
DescribeSMBSettingsResultWithDomainName (const Aws::String &value)
 
DescribeSMBSettingsResultWithDomainName (Aws::String &&value)
 
DescribeSMBSettingsResultWithDomainName (const char *value)
 
const ActiveDirectoryStatusGetActiveDirectoryStatus () const
 
void SetActiveDirectoryStatus (const ActiveDirectoryStatus &value)
 
void SetActiveDirectoryStatus (ActiveDirectoryStatus &&value)
 
DescribeSMBSettingsResultWithActiveDirectoryStatus (const ActiveDirectoryStatus &value)
 
DescribeSMBSettingsResultWithActiveDirectoryStatus (ActiveDirectoryStatus &&value)
 
bool GetSMBGuestPasswordSet () const
 
void SetSMBGuestPasswordSet (bool value)
 
DescribeSMBSettingsResultWithSMBGuestPasswordSet (bool value)
 
const SMBSecurityStrategyGetSMBSecurityStrategy () const
 
void SetSMBSecurityStrategy (const SMBSecurityStrategy &value)
 
void SetSMBSecurityStrategy (SMBSecurityStrategy &&value)
 
DescribeSMBSettingsResultWithSMBSecurityStrategy (const SMBSecurityStrategy &value)
 
DescribeSMBSettingsResultWithSMBSecurityStrategy (SMBSecurityStrategy &&value)
 
bool GetFileSharesVisible () const
 
void SetFileSharesVisible (bool value)
 
DescribeSMBSettingsResultWithFileSharesVisible (bool value)
 

Detailed Description

Definition at line 29 of file DescribeSMBSettingsResult.h.

Constructor & Destructor Documentation

◆ DescribeSMBSettingsResult() [1/2]

Aws::StorageGateway::Model::DescribeSMBSettingsResult::DescribeSMBSettingsResult ( )

◆ DescribeSMBSettingsResult() [2/2]

Aws::StorageGateway::Model::DescribeSMBSettingsResult::DescribeSMBSettingsResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetActiveDirectoryStatus()

const ActiveDirectoryStatus& Aws::StorageGateway::Model::DescribeSMBSettingsResult::GetActiveDirectoryStatus ( ) const
inline

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.

Definition at line 110 of file DescribeSMBSettingsResult.h.

◆ GetDomainName()

const Aws::String& Aws::StorageGateway::Model::DescribeSMBSettingsResult::GetDomainName ( ) const
inline

The name of the domain that the gateway is joined to.

Definition at line 62 of file DescribeSMBSettingsResult.h.

◆ GetFileSharesVisible()

bool Aws::StorageGateway::Model::DescribeSMBSettingsResult::GetFileSharesVisible ( ) const
inline

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Definition at line 296 of file DescribeSMBSettingsResult.h.

◆ GetGatewayARN()

const Aws::String& Aws::StorageGateway::Model::DescribeSMBSettingsResult::GetGatewayARN ( ) const
inline

Definition at line 38 of file DescribeSMBSettingsResult.h.

◆ GetSMBGuestPasswordSet()

bool Aws::StorageGateway::Model::DescribeSMBSettingsResult::GetSMBGuestPasswordSet ( ) const
inline

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

Definition at line 187 of file DescribeSMBSettingsResult.h.

◆ GetSMBSecurityStrategy()

const SMBSecurityStrategy& Aws::StorageGateway::Model::DescribeSMBSettingsResult::GetSMBSecurityStrategy ( ) const
inline

The type of security strategy that was specified for file gateway.

  • ClientSpecified: If you use 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. Only supported for S3 File Gateways.

  • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

  • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Definition at line 221 of file DescribeSMBSettingsResult.h.

◆ operator=()

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetActiveDirectoryStatus() [1/2]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetActiveDirectoryStatus ( ActiveDirectoryStatus &&  value)
inline

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.

Definition at line 144 of file DescribeSMBSettingsResult.h.

◆ SetActiveDirectoryStatus() [2/2]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetActiveDirectoryStatus ( const ActiveDirectoryStatus value)
inline

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.

Definition at line 127 of file DescribeSMBSettingsResult.h.

◆ SetDomainName() [1/3]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetDomainName ( Aws::String &&  value)
inline

The name of the domain that the gateway is joined to.

Definition at line 72 of file DescribeSMBSettingsResult.h.

◆ SetDomainName() [2/3]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetDomainName ( const Aws::String value)
inline

The name of the domain that the gateway is joined to.

Definition at line 67 of file DescribeSMBSettingsResult.h.

◆ SetDomainName() [3/3]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetDomainName ( const char *  value)
inline

The name of the domain that the gateway is joined to.

Definition at line 77 of file DescribeSMBSettingsResult.h.

◆ SetFileSharesVisible()

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetFileSharesVisible ( bool  value)
inline

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Definition at line 302 of file DescribeSMBSettingsResult.h.

◆ SetGatewayARN() [1/3]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetGatewayARN ( Aws::String &&  value)
inline

Definition at line 44 of file DescribeSMBSettingsResult.h.

◆ SetGatewayARN() [2/3]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetGatewayARN ( const Aws::String value)
inline

Definition at line 41 of file DescribeSMBSettingsResult.h.

◆ SetGatewayARN() [3/3]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetGatewayARN ( const char *  value)
inline

Definition at line 47 of file DescribeSMBSettingsResult.h.

◆ SetSMBGuestPasswordSet()

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetSMBGuestPasswordSet ( bool  value)
inline

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

Definition at line 195 of file DescribeSMBSettingsResult.h.

◆ SetSMBSecurityStrategy() [1/2]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetSMBSecurityStrategy ( const SMBSecurityStrategy value)
inline

The type of security strategy that was specified for file gateway.

  • ClientSpecified: If you use 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. Only supported for S3 File Gateways.

  • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

  • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Definition at line 238 of file DescribeSMBSettingsResult.h.

◆ SetSMBSecurityStrategy() [2/2]

void Aws::StorageGateway::Model::DescribeSMBSettingsResult::SetSMBSecurityStrategy ( SMBSecurityStrategy &&  value)
inline

The type of security strategy that was specified for file gateway.

  • ClientSpecified: If you use 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. Only supported for S3 File Gateways.

  • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

  • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Definition at line 255 of file DescribeSMBSettingsResult.h.

◆ WithActiveDirectoryStatus() [1/2]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithActiveDirectoryStatus ( ActiveDirectoryStatus &&  value)
inline

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.

Definition at line 178 of file DescribeSMBSettingsResult.h.

◆ WithActiveDirectoryStatus() [2/2]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithActiveDirectoryStatus ( const ActiveDirectoryStatus value)
inline

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.

Definition at line 161 of file DescribeSMBSettingsResult.h.

◆ WithDomainName() [1/3]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithDomainName ( Aws::String &&  value)
inline

The name of the domain that the gateway is joined to.

Definition at line 87 of file DescribeSMBSettingsResult.h.

◆ WithDomainName() [2/3]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithDomainName ( const Aws::String value)
inline

The name of the domain that the gateway is joined to.

Definition at line 82 of file DescribeSMBSettingsResult.h.

◆ WithDomainName() [3/3]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithDomainName ( const char *  value)
inline

The name of the domain that the gateway is joined to.

Definition at line 92 of file DescribeSMBSettingsResult.h.

◆ WithFileSharesVisible()

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithFileSharesVisible ( bool  value)
inline

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Definition at line 308 of file DescribeSMBSettingsResult.h.

◆ WithGatewayARN() [1/3]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithGatewayARN ( Aws::String &&  value)
inline

Definition at line 53 of file DescribeSMBSettingsResult.h.

◆ WithGatewayARN() [2/3]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithGatewayARN ( const Aws::String value)
inline

Definition at line 50 of file DescribeSMBSettingsResult.h.

◆ WithGatewayARN() [3/3]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithGatewayARN ( const char *  value)
inline

Definition at line 56 of file DescribeSMBSettingsResult.h.

◆ WithSMBGuestPasswordSet()

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithSMBGuestPasswordSet ( bool  value)
inline

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

Definition at line 203 of file DescribeSMBSettingsResult.h.

◆ WithSMBSecurityStrategy() [1/2]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithSMBSecurityStrategy ( const SMBSecurityStrategy value)
inline

The type of security strategy that was specified for file gateway.

  • ClientSpecified: If you use 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. Only supported for S3 File Gateways.

  • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

  • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Definition at line 272 of file DescribeSMBSettingsResult.h.

◆ WithSMBSecurityStrategy() [2/2]

DescribeSMBSettingsResult& Aws::StorageGateway::Model::DescribeSMBSettingsResult::WithSMBSecurityStrategy ( SMBSecurityStrategy &&  value)
inline

The type of security strategy that was specified for file gateway.

  • ClientSpecified: If you use 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. Only supported for S3 File Gateways.

  • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

  • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Definition at line 289 of file DescribeSMBSettingsResult.h.


The documentation for this class was generated from the following file: